テキスト

Retrieve Response

IDを指定して保存されたレスポンスを取得するか、バックグラウンドレスポンスをポーリングします。

GET
/v1/responses/{id}

概要

レスポンスの作成 で作成されたレスポンスを返します。background レスポンスの status が最終状態になるまでポーリングしたり、保存済みのレスポンスを再度読み取ったりするために使用します。

  • 対象となるレスポンス: store が false に設定されていないレスポンス、および background レスポンス。store: false の場合、TokenLab は何も保存しないため取得できません。
  • 保持期間: TokenLab は保存されたレスポンスを24時間保持します。最大30日間取得可能な場合もありますが、それに依存せず、必要な結果は保存してください。保持期間を過ぎると、そのIDは 404 を返します。
  • 所有権: 自分のアカウントで作成されたレスポンスのみ読み取ることができます。別のアカウントのIDを指定した場合、不明なIDと同様に 404 が返されます。
  • ステータス: queued、in_progress、completed、incomplete、failed、または cancelled。HTTPコードだけでなく status も確認してください。

stream および starting_after は、レスポンスが実行中の場合に適用されます。完了したレスポンスは JSON として返されます。include および include_obfuscation は、モデルがサポートしている場合に転送されます。

例

リクエスト

cURL
curl -X GET "https://api.tokenlab.sh/v1/responses/resp_abc123" \
  -H "Authorization: Bearer sk-your-api-key"

レスポンス例

レスポンス

200 OK
{
  "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
  }
}

エラー

ステータスコード意味
404response_not_foundIDが不明、別のアカウントに属している、削除された、store: false で作成された、または保持期間を過ぎています。
502upstream_response_read_failedTokenLab がレスポンスを生成したサービスからレスポンスを読み取れませんでした。後で再試行してください。
503response_state_unavailable, response_result_unavailableレスポンスの状態が一時的に利用できません。後で再試行してください。

認証

BearerAuth
AuthorizationBearer <token>

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

場所: header

パスパラメータ

id*string

POST /v1/responses によって返されたレスポンスID。

クエリパラメータ

include?array<string>

含める追加のレスポンスフィールド。モデルがサポートしている場合に転送されます。

include_obfuscation?boolean

ストリーミングイベントに難読化フィールドを含めるかどうか。モデルがサポートしている場合に転送されます。

stream?boolean

レスポンスをイベントストリームとして取得するかどうか。レスポンスの実行中に適用されます。完了したレスポンスはJSONとして返されます。

starting_after?integer

ストリーミングイベントの返却を開始するシーケンス番号。streamがtrueの場合のみ適用されます。

レスポンス

application/json

application/json

application/json

application/json