メインコンテンツへスキップ

​
はじめに

OneSight Open APIは、外部アプリケーション（モバイルアプリ、POSシステム、IoTデバイスなど）がOneSightプラットフォームのAI機能を利用するためのRESTful APIです。

​
主な機能

機能説明エンドポイント
AIチャットOpenAI互換チャットAPI（ストリーミング対応）POST /api/openapi/v1/chat/completions
データ収集スキーマフリーイベントデータ収集POST /api/openapi/v1/data/events
モデル一覧利用可能なOpen APIモデル照会GET /api/openapi/v1/models
使用量照会APIキー別使用量統計GET /api/openapi/v1/usage

​
アーキテクチャ

外部アプリ (iOS, POS, IoT)
        |
        | HTTPS + Bearer API Key
        v
+----------------------------+
|  OneSight Gateway          |
|  /api/openapi/v1/*         |
|                            |
|  認証 -> 拡充 -> プロキシ   |
+------------+---------------+
             |
             v
+----------------------------+
|  RAG Service (LLM)         |
|  AI応答生成 + ツール実行    |
+----------------------------+

​
クイックスタート

​
1. APIキー発行

テナント管理者としてログインし、プロフィールメニューからOpen APIページでAPIキーを発行します。

​
2. チャットAPIを呼び出す

curl -X POST https://api.aika.life/api/openapi/v1/chat/completions \
  -H "Authorization: Bearer osk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shopping-assistant",
    "messages": [
      {"role": "user", "content": "今晩のメニューをおすすめしてください"}
    ],
    "stream": true
  }'

​
3. レスポンスを確認

SSEストリーミング形式で応答されます： 
data: {"choices":[{"delta":{"content":"カレー"},"index":0}]}

data: [DONE]

​
認証

すべてのOpen APIリクエストには Authorization: Bearer {API_KEY} ヘッダーが必要です。 詳細は認証ページをご覧ください。

​
モデル分離

Open APIで使用するAIモデルはテナントチャットモデルとは別々に管理されます。 管理画面で Open API タイプのモデルを作成すると、外部アプリからのみ利用できます。