メインコンテンツへスキップ
POST
/
v1
/
chat
/
completions
OpenAI chat completions
curl --request POST \
  --url https://maas.apigo.ai/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "gpt-4o",
  "messages": [
    {
      "role": "system",
      "content": "<string>"
    }
  ],
  "temperature": 1,
  "stream": true
}
'
{
  "id": "<string>",
  "object": "chat.completion",
  "choices": [
    {
      "index": 123,
      "message": {
        "role": "system",
        "content": "<string>"
      },
      "finish_reason": "<string>"
    }
  ],
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 123,
    "total_tokens": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.apigo.ai/llms.txt

Use this file to discover all available pages before exploring further.

チャット会話のモデル応答を作成します。 既存の OpenAI SDK、チャット クライアント、または従来のチャット完了ワークフローとの互換性が必要な場合、このエンドポイントが依然として最も安全なデフォルトです。サポートされるフィールドは、特に推論、ツールの使用、マルチモーダル入力など、モデルによって異なります。

​
統合ガイダンス

  • Authorization: Bearer {API_KEY}で認証する
  • これを既存の OpenAI スタイルのチャット統合のデフォルトのエントリ ポイントとして使用します
  • 構造化された出力、マルチモーダル入力、およびツールのためのより統合されたインターフェイスが必要な場合は、/v1/responses をお勧めします。
  • ストリーミング クライアントは、最後の JSON 応答を待つのではなく、SSE チャンクを段階的に処理する必要があります。

​
リクエストのハイライト

  • messages が必要であり、会話履歴を保持します
  • model は必須であり、ターゲットモデルを選択します
  • temperature と top_p は両方ともサンプリングに影響しますが、ほとんどの統合ではどちらか 1 つだけを調整する必要があります。
  • トークンレベルの確率が必要な場合は、logprobs と top_logprobs を組み合わせます。
  • キャッシュと安全性の帰属については、prompt_cache_key および safety_identifier を推奨します。

​
回答のハイライト

  • 通常、プレーンテキストは choices[0].message.content から読み取られます。
  • ツール呼び出しは message.tool_calls から読み取ることができます
  • ストリーミング応答は SSE チャンクとして到着するため、段階的にマージする必要があります
  • 使用状況のアカウンティングは、より詳細なトークンの内訳を含め、usage を通じて公開されます。

承認

​
Authorization
string
header
必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

ボディ

application/json
​
model
string
必須
例:

"gpt-4o"

​
messages
object[]
必須
​
temperature
number<double>

采样温度。类型：double。取值范围：0-2。

必須範囲: 0 <= x <= 2
​
stream
boolean

レスポンス

Successful chat completion response

​
id
string
​
object
string
例:

"chat.completion"

​
choices
object[]
​
usage
object