Responses API - Hostlinku Docs

Hostlinku は、OpenAI Responses API - Codex CLI で使用されるフォーマット - と互換性のあるエンドポイントを提供します。 OpenAI Agents SDK、およびOpenAI SDKのclient.responses.create()メソッドで使用されるフォーマットです。 base URL を変更するだけで済みます。API キー、残高、Service Mode、レート制限、およびリクエストログは、/v1/chat/completions および /v1/messages と同じです。

POST https://api.hostlinku.com/v1/responses
Authorization: Bearer sk-isi-api-key-kamu
Content-Type: application/json

すべての応答には、ヘッダー x-request-id（リクエスト ID Hostlinku、フォーマット resp_…）が含まれており、非ストリーミングの成功応答には x-model が含まれます。

クイック設定

各ツールの詳細なガイドは、Codex CLI および OpenAI Agents SDK に掲載されています。 Codex CLI (~/.codex/config.toml)

model = "gpt-5-5"
model_provider = "hostlinku"

[model_providers.hostlinku]
name = "Hostlinku"
base_url = "https://api.hostlinku.com/v1"
env_key = "HOSTLINKU_API_KEY"
wire_api = "responses"

export HOSTLINKU_API_KEY=sk-isi-api-key-kamu
codex

Python（OpenAI公式SDK）

from openai import OpenAI

client = OpenAI(api_key="sk-isi-api-key-kamu", base_url="https://api.hostlinku.com/v1")

response = client.responses.create(
    model="gpt-5-5",
    instructions="Jawab singkat dalam bahasa Indonesia.",
    input="Apa itu API gateway?",
    max_output_tokens=256,
)
print(response.output_text)
print(response.usage.input_tokens, response.usage.output_tokens)

Node.js

import OpenAI from "openai";

const client = new OpenAI({ apiKey: "sk-isi-api-key-kamu", baseURL: "https://api.hostlinku.com/v1" });
const response = await client.responses.create({
  model: "claude-sonnet-4-6",
  input: "Halo!",
  max_output_tokens: 256,
});
console.log(response.output_text);

OpenAI Agents SDK (Python)

from agents import Agent, Runner, set_default_openai_client, set_tracing_disabled
from openai import AsyncOpenAI

set_default_openai_client(AsyncOpenAI(api_key="sk-isi-api-key-kamu", base_url="https://api.hostlinku.com/v1"))
set_tracing_disabled(True)  # tracing OpenAI tidak tersedia lewat gateway

agent = Agent(name="Asisten", instructions="Jawab singkat.", model="gpt-5-5")
result = Runner.run_sync(agent, "Sebutkan 3 bahasa pemrograman.")
print(result.final_output)

bodyパラメータ

パラメータ	タイプ	説明
`model`	`string`	必須。 slug型番 Hostlinku。
`input`	`string` \| `array`	必須。単一のテキスト、または配列の項目：`message`（`role` + `content` には `input_text`/`input_image`/…が含まれる）、 `function_call`、`function_call_output`、`reasoning`。
`instructions`	`string`	システムプロンプト（開発者向けメッセージ）。
`max_output_tokens`	`integer`	出力トークンの上限。モデルの出力上限を超えた場合、`400`として拒否されます。
`stream`	`boolean`	SSE用の`true`（下記参照）。
`tools`, `tool_choice`, `parallel_tool_calls`	-	関数呼び出し形式 Responses (`{ "type": "function", "name", "parameters" }`)。
`reasoning`	`object`	例：`{ "effort": "low" \| "medium" \| "high", "summary": "auto" }`。
`include`	`string[]`	例：`["reasoning.encrypted_content"]` - 暗号化された項目推論は、次のターンで再送信できるよう、そのままの状態で返されます（Codex CLIで使用）。
`text`, `truncation`, `temperature`, `top_p`, `metadata`, `user`, `prompt_cache_key`, `safety_identifier`	-	OpenAIの仕様に準拠；モデルに反映済み。
`store`	`boolean`	常に `false` として扱われます（Stateless を参照）。
`previous_response_id`, `conversation`, `background`	-	未対応 → `400 invalid_request_error`。

認識されないその他のフィールドはゲートウェイに転送されます（モデルでサポートされていないパラメータは無視されます）。無効なボディは400 invalid_request_errorとして拒否され、フィールドごとの詳細はerror.details.issuesに記載されています。

非ストリーミングの応答

{
  "id": "resp_…",
  "object": "response",
  "created_at": 1791850828,
  "completed_at": 1791850829,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "model": "gpt-5-5",
  "output": [
    { "id": "rs_…", "type": "reasoning", "summary": [], "encrypted_content": "…" },
    {
      "id": "msg_…",
      "type": "message",
      "status": "completed",
      "role": "assistant",
      "content": [{ "type": "output_text", "text": "API gateway adalah …", "annotations": [] }]
    }
  ],
  "usage": {
    "input_tokens": 20,
    "output_tokens": 19,
    "total_tokens": 39,
    "input_tokens_details": { "cached_tokens": 0 },
    "output_tokens_details": { "reasoning_tokens": 12 }
  },
  "previous_response_id": null,
  "store": false,
  "hostlinku": { "cost": 0.00031, "currency": "🪙", "serviceMode": "performance", "latencyMs": 1420 }
}

id および model は、常に Hostlinku のパブリック ID です。ブロックhostlinkuは拡張情報（OpenAIのSDKはこれを無視する）であり、、Service Mode API keyの費用およびレイテンシが含まれている。 status: "incomplete" および incomplete_details.reason = "max_output_tokens" は、出力が max_output_tokens によって切り詰められていることを意味しますが、実際のトークンに基づいて課金されます。

ストリーミング (`stream: true`)

ゲートウェイは、Responses API（event: + data:）のフレーム形式でSSEイベントを転送します。これには、アップストリームからのsequence_numberも含まれます：

event: response.created
data: {"type":"response.created","sequence_number":0,"response":{"id":"resp_…","object":"response","status":"in_progress","model":"gpt-5-5","output":[],…}}

event: response.in_progress
data: {"type":"response.in_progress","sequence_number":1,"response":{…}}

event: response.output_item.added
data: {"type":"response.output_item.added","sequence_number":2,"output_index":0,"item":{"id":"msg_…","type":"message","status":"in_progress","role":"assistant","content":[]}}

event: response.content_part.added
data: {"type":"response.content_part.added","sequence_number":3,"item_id":"msg_…","output_index":0,"content_index":0,"part":{"type":"output_text","text":"","annotations":[]}}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":4,"item_id":"msg_…","output_index":0,"content_index":0,"delta":"API gateway"}

event: response.output_text.done
data: {"type":"response.output_text.done","sequence_number":5,"item_id":"msg_…","output_index":0,"content_index":0,"text":"API gateway adalah …"}

event: response.content_part.done
data: {"type":"response.content_part.done","sequence_number":6,…}

event: response.output_item.done
data: {"type":"response.output_item.done","sequence_number":7,"output_index":0,"item":{"id":"msg_…","type":"message","status":"completed",…}}

event: response.completed
data: {"type":"response.completed","sequence_number":8,"response":{"id":"resp_…","status":"completed","model":"gpt-5-5","output":[…],"usage":{"input_tokens":20,"output_tokens":19,"total_tokens":39,…}}}

注：

最終的な使用量は、response.completed（またはresponse.incomplete）のオブジェクトresponseに記録されます。費用は、そのイベント後の実際の使用量に基づいて計算されます。
ツールコールは、response.output_item.added（type: "function_call"）、response.function_call_arguments.delta、およびresponse.function_call_arguments.doneを経由して送信されます。
ストリームが途中で失敗した場合、ゲートウェイはevent: errorと{"type":"error","code":…,"message":…}を送信し、偽のresponse.completedは送信しない。
最初のバイトが送信される前のエラー（残高不足、モデルが存在しない、レート制限）は、正しいHTTPステータスを伴う通常のJSONレスポンスとして返されます。SDK OpenAIでは、これらを例外（AuthenticationError、NotFoundError、 RateLimitError、…）。

ツールの呼び出し（関数の呼び出し）

tools = [{
    "type": "function",
    "name": "get_time",
    "description": "Waktu saat ini di sebuah kota",
    "parameters": {"type": "object", "properties": {"city": {"type": "string"}}, "required": ["city"]},
}]

r1 = client.responses.create(model="claude-sonnet-4-6", input="Jam berapa sekarang di Jakarta?", tools=tools, store=False)
call = next(o for o in r1.output if o.type == "function_call")

# Giliran berikutnya: kirim ulang riwayat + hasil tool (stateless)
r2 = client.responses.create(
    model="claude-sonnet-4-6",
    tools=tools,
    store=False,
    input=[
        {"type": "message", "role": "user", "content": [{"type": "input_text", "text": "Jam berapa sekarang di Jakarta?"}]},
        *[o.model_dump(exclude_none=True) for o in r1.output],
        {"type": "function_call_output", "call_id": call.call_id, "output": '{"time": "10:00 WIB"}'},
    ],
)
print(r2.output_text)

フォーマットエラー

{ "error": { "message": "API key tidak valid atau sudah dicabut.", "type": "authentication_error", "param": null, "code": "invalid_api_key" } }

HTTP	`error.type`	`error.code`	一般的な原因
400	`invalid_request_error`	`invalid_request`	ボディが無効です。`max_output_tokens`がモデルの制限を超えています。`previous_response_id`が送信されました。Service Modeキーにはモデルが存在しません。
401	`authentication_error`	`invalid_api_key`	APIキーが間違っている、無効化されている、または有効期限が切れている、あるいはAPIキーなしでリクエストが行われた。
402	`insufficient_quota`	`insufficient_quota`	残高が不足しているか、APIキーのクレジット上限に達しています。
403	`permission_error`	-	アカウントが停止されました／アクセスが拒否されました。
404	`not_found_error`	`model_not_found` / `not_found`	slugモデルが存在しない、または `GET /v1/responses/{id}`（ステートレス）。
429	`rate_limit_error`	`rate_limit_exceeded`	リクエストの制限に達しました（ヘッダー `Retry-After` を参照）。
503	`server_error`	`model_unavailable` / `server_error`	モデル/アップストリームが利用できません - 再試行しても問題ありません。

エラーメッセージには、アップストリームプロバイダーの識別子が含まれていません。Chat Completions 形式のエラーコードの完全な一覧は、エラーに記載されています。

​クイック設定

​bodyパラメータ

​非ストリーミングの応答

​ストリーミング (stream: true)

​ツールの呼び出し（関数の呼び出し）

​フォーマットエラー