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.
このページには、HTTP エンドポイントのメモと、直接の cURL、Python、Node.js リクエストの例のみが保管されています。
エンドポイントの概要
| Endpoint | Summary |
|---|
| ZXプロテクト0ZX | マルチターン会話、ツール呼び出し、およびオプションのストリーミング用の標準チャット完了エンドポイント。 |
| ZXプロテクト0ZX | 構造化出力、マルチモーダル入力、将来の機能拡張のための、新しい統合応答エンドポイント。 |
ZXプロテクト0ZX
マルチターン会話、ツール呼び出し、およびオプションのストリーミング用の標準チャット完了エンドポイント。
リクエストメモ
- 認可による認証: Bearer ;コア ペイロード フィールドはモデルとメッセージです。
- メッセージは、システム、ユーザー、アシスタントの履歴を順番に保存する必要があります。 SSE 出力に stream=true を追加します。
- OpenAI 互換ゲートウェイの場合、通常、これが最初に使用する最も安全なデフォルトのテキスト エンドポイントです。
応答メモ
- 同期出力は通常、choices[0].message.content から読み取られます。
- ツール呼び出しが有効な場合、tool_calls とフォローアップ ツール交換を一緒に処理します。
- ストリーミング モードは、1 つの完全な JSON 応答ではなく、SSE チャンクを返します。
Examples
cURL
chat.completions
curl --request POST \
--url https://api.tokenops.ai/v1/chat/completions \
--header 'Authorization: Bearer ${YOUR_API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
"model": "gpt-4.1-mini",
"messages": [
{ "role": "system", "content": "You are a concise API assistant." },
{ "role": "user", "content": "Give me a contact form field definition." }
]
}'
Python
requests
import requests
response = requests.post(
'https://api.tokenops.ai/v1/chat/completions',
headers={
'Authorization': 'Bearer ${YOUR_API_KEY}',
'Content-Type': 'application/json'
},
json={
'model': 'gpt-4.1-mini',
'messages': [
{'role': 'system', 'content': 'You are a concise API assistant.'},
{'role': 'user', 'content': 'Give me a contact form field definition.'}
]
},
timeout=60
)
print(response.json())
Node.js
fetch
const response = await fetch('https://api.tokenops.ai/v1/chat/completions', {
method: 'POST',
headers: {
Authorization: 'Bearer ${YOUR_API_KEY}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
model: 'gpt-4.1-mini',
messages: [
{ role: 'system', content: 'You are a concise API assistant.' },
{ role: 'user', content: 'Give me a contact form field definition.' }
]
})
})
console.log(await response.json())
応答例(200)
response
{
"id": "chatcmpl_123",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "{\"name\":\"email\",\"type\":\"string\"}"
}
}
]
}
ZXプロテクト0ZX
構造化出力、マルチモーダル入力、将来の機能拡張のための、新しい統合応答エンドポイント。
リクエストメモ
- 引き続きベアラー認証を使用しますが、メインのペイロード形状はメッセージではなく入力と命令を中心としています。
- テキストと構造化出力に 1 つのエンドポイント形状が必要な場合は、従来の chat.completions よりもこれを優先します。
- 通常、新しい応答形式とマルチモーダル機能が最初にここに表示されます。
応答メモ
- コンシューマは通常、choices[0].message ではなく、output[] または Output_text から読み取ります。
- ワークフローが非同期またはツール主導になると、このエンドポイントは通常、より豊富なステータス フィールドを公開します。
- 移行作業には、フィールド マッピング、再試行、サーバー側のログ記録が含まれる必要があります。
Examples
cURL
responses
curl --request POST \
--url https://api.tokenops.ai/v1/responses \
--header 'Authorization: Bearer ${YOUR_API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
"model": "gpt-4.1-mini",
"input": "Return a JSON contact form field definition."
}'
Python
requests
import requests
response = requests.post(
'https://api.tokenops.ai/v1/responses',
headers={
'Authorization': 'Bearer ${YOUR_API_KEY}',
'Content-Type': 'application/json'
},
json={
'model': 'gpt-4.1-mini',
'input': 'Return a JSON contact form field definition.'
},
timeout=60
)
print(response.json())
Node.js
fetch
const response = await fetch('https://api.tokenops.ai/v1/responses', {
method: 'POST',
headers: {
Authorization: 'Bearer ${YOUR_API_KEY}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
model: 'gpt-4.1-mini',
input: 'Return a JSON contact form field definition.'
})
})
console.log(await response.json())
応答例(200)
response
{
"id": "resp_123",
"status": "completed",
"output": [
{
"type": "output_text",
"text": "{\"name\":\"email\",\"type\":\"string\"}"
}
]
}
