OpenResponses API

​

認証、セキュリティ、ルーティング

• 認証パスは gateway.auth.mode と一致します。shared-secret（token/password）は Authorization: Bearer <token-or-password> を使用します。trusted-proxy は ID 対応プロキシヘッダーを使用します（同一ホストのループバックプロキシには gateway.auth.trustedProxy.allowLoopback = true が必要で、Forwarded/X-Forwarded-*/X-Real-IP ヘッダーが存在しない場合は gateway.auth.password / OPENCLAW_GATEWAY_PASSWORD による同一ホスト直接フォールバックがあります）。プライベート ingress 上の none は認証ヘッダーを必要としません。信頼済みプロキシ認証を参照してください。
• このエンドポイントは、Gateway インスタンスへの完全なオペレーターアクセスとして扱ってください。
• shared-secret 認証モードは、より狭い bearer 宣言の x-openclaw-scopes を無視し、完全なデフォルトオペレータースコープセットを復元します: operator.admin、operator.approvals、operator.pairing、operator.read、operator.talk.secrets、operator.write。このエンドポイント上のチャットターンは、所有者送信者ターンとして扱われます。
• 信頼済み ID を持つ HTTP モード（trusted-proxy、または gateway.auth.mode="none"）は、存在する場合は x-openclaw-scopes を尊重し、それ以外の場合はオペレーターのデフォルトスコープセットにフォールバックします。呼び出し元が明示的にスコープを狭め、operator.admin を省略した場合にのみ、所有者セマンティクスは失われます。
• model: "openclaw"、"openclaw/default"、"openclaw/<agentId>"、または x-openclaw-agent-id ヘッダーでエージェントを選択します。
• x-openclaw-model を使用して、選択したエージェントのバックエンドモデルを上書きします（ID を持つ認証パスでは operator.admin が必要です）。
• 明示的なセッションルーティングには x-openclaw-session-key を使用します（予約済み名前空間 subagent:、cron:、acp: を使用している場合は 400 invalid_request_error で拒否されます）。
• デフォルト以外の合成 ingress チャンネルコンテキストには x-openclaw-message-channel を使用します。

​

セッションの挙動

​

リクエスト形状

​

項目（入力）

​

message

• system と developer はシステムプロンプトに追加されます。
• 最新の user または function_call_output 項目が「現在のメッセージ」になります。
• それ以前の user/assistant メッセージは、コンテキスト用の履歴として含まれます。

​

function_call_output（ターンベースツール）

{
  "type": "function_call_output",
  "call_id": "call_123",
  "output": "{\"temperature\": \"72F\"}"
}

​

reasoning と item_reference

​

ツール（クライアント側 function tools）

​

画像（input_image）

{
  "type": "input_image",
  "source": { "type": "url", "url": "https://example.com/image.png" }
}

​

ファイル（input_file）

{
  "type": "input_file",
  "source": {
    "type": "base64",
    "media_type": "text/plain",
    "data": "SGVsbG8gV29ybGQh",
    "filename": "hello.txt"
  }
}

• ファイル内容はデコードされ、ユーザーメッセージではなくシステムプロンプトに追加されるため、一時的なままです（セッション履歴には永続化されません）。
• デコードされたファイルテキストは、追加前に信頼されない外部コンテンツとしてラップされるため、ファイルバイトは信頼済み命令ではなくデータとして扱われます。挿入されるブロックは明示的な境界マーカー（<<<EXTERNAL_UNTRUSTED_CONTENT id="...">>> / <<<END_EXTERNAL_UNTRUSTED_CONTENT id="...">>>）と Source: External メタデータ行を使用します。プロンプト予算を保つため、長い SECURITY NOTICE: バナーは意図的に省略されますが、境界マーカーとメタデータは引き続き適用されます。
• PDF はまずテキスト解析されます。テキストがほとんど見つからない場合、最初のページが画像にラスタライズされてモデルに渡され、挿入されるファイルブロックはプレースホルダー [PDF content rendered to images] を使用します。

• files.allowUrl: true
• images.allowUrl: true
• maxUrlParts: 8（リクエストごとの URL ベースの input_file + input_image パート合計）
• リクエストは保護されます（DNS 解決、プライベート IP ブロック、リダイレクト上限、タイムアウト）。
• 任意のホスト名許可リストは入力タイプごとにサポートされます（files.urlAllowlist、images.urlAllowlist）: 完全一致ホスト（"cdn.example.com"）またはワイルドカードサブドメイン（"*.assets.example.com"、apex には一致しません）。空または省略された許可リストは、ホスト名許可リスト制限がないことを意味します。
• URL ベースのフェッチを完全に無効化するには、files.allowUrl: false および/または images.allowUrl: false を設定します。

​

ファイル + 画像の制限（設定）

{
  gateway: {
    http: {
      endpoints: {
        responses: {
          enabled: true,
          maxBodyBytes: 20000000,
          maxUrlParts: 8,
          files: {
            allowUrl: true,
            urlAllowlist: ["cdn.example.com", "*.assets.example.com"],
            allowedMimes: [
              "text/plain",
              "text/markdown",
              "text/html",
              "text/csv",
              "application/json",
              "application/pdf",
            ],
            maxBytes: 5242880,
            maxChars: 60000,
            maxRedirects: 3,
            timeoutMs: 10000,
            pdf: {
              maxPages: 4,
              maxPixels: 4000000,
              minTextChars: 200,
            },
          },
          images: {
            allowUrl: true,
            urlAllowlist: ["images.example.com"],
            allowedMimes: [
              "image/jpeg",
              "image/png",
              "image/gif",
              "image/webp",
              "image/heic",
              "image/heif",
            ],
            maxBytes: 10485760,
            maxRedirects: 3,
            timeoutMs: 10000,
          },
        },
      },
    },
  },
}

​

ストリーミング（SSE）

• Content-Type: text/event-stream
• 各イベント行は event: <type> と data: <json> です
• ストリームは data: [DONE] で終了します

​

使用方法

​

エラー

{ "error": { "message": "...", "type": "invalid_request_error" } }

​

例

curl -sS http://127.0.0.1:18789/v1/responses \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'x-openclaw-agent-id: main' \
  -d '{
    "model": "openclaw",
    "input": "hi"
  }'

curl -N http://127.0.0.1:18789/v1/responses \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'x-openclaw-agent-id: main' \
  -d '{
    "model": "openclaw",
    "stream": true,
    "input": "hi"
  }'

​

関連

• OpenAI チャット補完
• オペレータースコープ
• OpenAI