テキスト

レスポンスの作成

OpenAI Responses API 形式を使用してレスポンスを作成します

POST
/v1/responses

モデルの accepted_request_formats に openai_responses が含まれている場合は、このエンドポイントを使用します。リクエストとレスポンスには Responses API 形式が使用され、変換は行われません。その形式に対応していないモデルでは 400 が返されるため、その場合は Chat Completions を使用してください。オプションのフィールドおよびサポートされる値は、選択したモデルによって異なります。

リクエストボディ

modelstring必須

使用するモデルの ID。モデル で利用可能なオプションを参照してください。

inputstring | array

レスポンスの入力。リクエストで再利用可能な prompt を使用する場合、または previous_response_id を指定して保存されたレスポンスを継続する場合は省略可能です。

各アイテムは type を持つオブジェクトです。一般的なタイプは次のとおりです:

  • message: ロールとコンテンツを含む会話メッセージ
  • function_call: 関数呼び出しリクエスト
  • function_call_output: 関数呼び出しからの出力
  • reasoning: 以前のレスポンスからの思考アイテム。変更せずにそのまま送信してください

その他のアイテムタイプは、選択したモデルによって異なります。

マルチモーダル入力の場合、message.content にはプレーンな文字列またはコンテンツブロックの配列のいずれかを指定できます。画像対応モデルでは、URL や Base64 文字列をプレーンテキストに直接埋め込むのではなく、画像を input_image ブロックとして渡してください。

コンテンツブロックの例:

  • { "type": "input_text", "text": "Describe this image" }
  • { "type": "input_image", "image_url": "https://example.com/image.jpg" }
  • { "type": "input_image", "image_url": "data:image/png;base64,..." }
instructionsstring

モデルへのシステム指示(システムメッセージと同等)。

max_output_tokensinteger

生成するトークンの最大数。

temperaturenumber

サンプリング温度。サポートされる値およびデフォルト値は、選択したモデルによって異なります。

toolsarray

モデルが呼び出す可能性のあるツール。サポートされるタイプと組み合わせは、選択したモデルによって異なります。

streambooleanデフォルト: false

true の場合、イベントのストリームを返します。ストリーミング を参照してください。

previous_response_idstring

会話を継続するための以前のレスポンスの ID。レスポンスはお客様のアカウントに属し、現在も保存されている必要があります。そうでない場合、リクエストはコード response_not_found とともに 404 を返します。そのレスポンスを生成したモデルで継続してください。レスポンスを生成したサービスが一時的に利用できない場合、リクエストは 503 を返すことがあります。

storebooleanデフォルト: true

後から取得するため、および previous_response_id 用にレスポンスを保存するかどうか。false の場合、TokenLab はレスポンスを保持しないため、GET /v1/responses/{id} で取得することはできません。

backgroundbooleanデフォルト: false

非同期実行をリクエストします。サポート状況は選択したモデルによって異なります。作成呼び出しは即座に戻り、通常は status が queued または in_progress になります。status が completed、incomplete、failed、または cancelled になるまで レスポンスの取得 をポーリングしてください。バックグラウンド処理が一時的に利用できない場合、バックグラウンドリクエストは 503 を返すことがあります。

tool_choicestring | object

auto、none、required、または1つのツールを指定するオブジェクトなどのツール選択ポリシー。サポートされる値は選択したモデルによって異なります。

includearray

選択したモデルがサポートしている場合に、返す追加の出力セクション。

stream_optionsobject

ストリーミングオプション。選択したモデルがサポートしている場合、include_obfuscation が転送されます。

truncationstring

選択したモデルがサポートしている場合の、長い会話に対する切り捨て戦略。

service_tierstring

TokenLab は Responses リクエストを標準サービスティアで提供および請求します。auto および default が受け付けられます。flex や priority などのその他の値はリクエストから削除され、リクエストは標準価格で請求されます。

promptobject

再利用可能なプロンプトテンプレートおよび変数への参照。

metadataobject

レスポンスとともに保存されるカスタムメタデータ。

textobject

テキスト出力設定。text.format のサポートは選択したモデルによって異なります。

parallel_tool_callsboolean

選択したモデルがサポートしている場合に、複数のツール呼び出しを並列で実行することを許可するかどうか。

top_pnumber

Nucleus サンプリングパラメータ(0〜1)。

reasoningobject

effort を含む推論オプション。選択したモデルによって異なります。

レスポンス

idstring

レスポンスの一意の識別子。

objectstring

常に response。

created_atinteger

レスポンスが作成された日時の Unix タイムスタンプ。

statusstring

レスポンスの状態: queued、in_progress、completed、incomplete、failed、または cancelled。HTTP リクエストが成功した場合でも、このフィールドを確認してください。

outputarray

モデルによって生成された出力アイテムのリスト。

usageobject

トークン使用量の統計。

関連エンドポイント

  • GET /v1/responses/{id} は保存されたレスポンスを取得します。
  • DELETE /v1/responses/{id} は保存されたレスポンスを削除します。生成処理はキャンセルされません。
  • POST /v1/responses/compact は会話をコンパクト化し、response.compaction オブジェクトを返します。
  • wss://api.tokenlab.sh/v1/responses は WebSocket 経由でレスポンスを作成します。ストリーミング を参照してください。
  • Cancel、input-items、および input-tokens エンドポイントは現在利用できません。

リクエスト

cURL
curl -X POST "https://api.tokenlab.sh/v1/responses" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.6-terra",
    "input": [
      {"type": "message", "role": "user", "content": "Hello!"}
    ],
    "max_output_tokens": 1000
  }'
Python
from openai import OpenAI

client = OpenAI(
    api_key="sk-your-api-key",
    base_url="https://api.tokenlab.sh/v1"
)

response = client.responses.create(
    model="gpt-5.6-terra",
    input=[
        {"type": "message", "role": "user", "content": "Hello!"}
    ],
    max_output_tokens=1000
)

print(response.output)
JavaScript
import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'sk-your-api-key',
  baseURL: 'https://api.tokenlab.sh/v1'
});

const response = await client.responses.create({
  model: 'gpt-5.6-terra',
  input: [
    { type: 'message', role: 'user', content: 'Hello!' }
  ],
  max_output_tokens: 1000
});

console.log(response.output);
Go
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    payload := map[string]interface{}{
        "model": "gpt-5.6-terra",
        "input": []map[string]interface{}{
            {"type": "message", "role": "user", "content": "Hello!"},
        },
        "max_output_tokens": 1000,
    }
    body, _ := json.Marshal(payload)

    req, _ := http.NewRequest("POST", "https://api.tokenlab.sh/v1/responses", bytes.NewBuffer(body))
    req.Header.Set("Authorization", "Bearer sk-your-api-key")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, _ := client.Do(req)
    defer resp.Body.Close()

    var result map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&result)
    fmt.Println(result["output"])
}
PHP
<?php
$ch = curl_init('https://api.tokenlab.sh/v1/responses');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'Authorization: Bearer sk-your-api-key'
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'model' => 'gpt-5.6-terra',
        'input' => [
            ['type' => 'message', 'role' => 'user', 'content' => 'Hello!']
        ],
        'max_output_tokens' => 1000
    ])
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data['output']);

Vision 入力の例

画像対応モデルを使用するには、message.content 内に画像を input_image ブロックとして配置します。image_url の値には、公開 URL または Base64 データ URL のいずれかを指定できます。

{
  "model": "gpt-5.6-terra",
  "input": [
    {
      "type": "message",
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Please describe this image."
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/demo.jpg"
        }
      ]
    }
  ]
}
{
  "model": "gpt-5.6-terra",
  "input": [
    {
      "type": "message",
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Please describe this image."
        },
        {
          "type": "input_image",
          "image_url": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ..."
        }
      ]
    }
  ]
}

レスポンス

Response
{
  "id": "resp_abc123",
  "object": "response",
  "created_at": 1706000000,
  "status": "completed",
  "model": "gpt-5.6-terra",
  "output": [
    {
      "id": "msg_abc123",
      "type": "message",
      "status": "completed",
      "role": "assistant",
      "content": [
        {"type": "output_text", "text": "Hello! How can I help you today?", "annotations": []}
      ]
    }
  ],
  "usage": {
    "input_tokens": 10,
    "output_tokens": 12,
    "total_tokens": 22
  }
}

エラー

エラーには OpenAI スタイルの error オブジェクトが使用されます。一般的なケース: 無効なフィールドまたは Responses 形式に対応していないモデルの場合は 400、無効なキーの場合は 401、残高不足の場合は 402、不明な previous_response_id の場合は 404、レート制限の場合は 429、モデルが現在リクエストを処理できない場合は 503 が返されます。APIエラーの処理 を参照してください。

認証

BearerAuth
AuthorizationBearer <token>

APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。

場所: header

ヘッダー

X-TokenLab-Delivery-Policy?string

リクエストごとの配信ポリシー。APIキーおよびWorkspaceのデフォルト設定を上書きします。自動的にまず TokenLab Verified を試行し、出力、リクエストの受け入れ、または永続的なリソース作成の前に、一度だけ Official に切り替える場合があります。

指定できる値

  • "auto"
  • "verified"
  • "official"
Idempotency-Key?string

同じリクエストの二重実行を防ぐためのオプションのキー。リクエストごとにUUIDなどの新しい一意の値を送信し、タイムアウト後の再試行のために保持してください。同じキーでの再試行は再実行されず、409とidempotency_replay_unavailable、またはボディが変更された場合は通常idempotency_conflictを返します。例外:非ストリーム結果がクライアント切断後に完了した場合、24時間以内に同じキーとボディで再試行すると、その結果(最大1MB)がヘッダーIdempotent-Replayed: trueと共に返され、二重課金は発生しません。255文字を超えるキーは無視され、そのリクエストにはべき等性の保護が適用されません。background: trueの場合、同じキーとボディでの再試行は元のレスポンスオブジェクトを返し、二重のレスポンス作成や課金は行われません。異なるボディは拒否され、そのステータスコードは保証されません。詳細はRetry safely with an idempotency keyを参照してください。

長さ1 <= length <= 255

リクエストボディ

application/json

レスポンス

application/json

application/json

application/json

application/json

application/json