API v1Updated 2026-09-16

Responses API

Endpoint POST /v1/responses yang kompatibel OpenAI, dengan skema event response.* native untuk streaming.

POST /v1/responses adalah pengganti drop-in untuk OpenAI Responses API — protokol modern yang dibangun di atas objek response dan event terstruktur response.*. Kode Responses-API yang sudah ada dapat berjalan ke gateway hanya dengan mengubah base URL.

Endpoint#

POST/v1/responses

Auth: api-key

Membuat response. Respons non-streaming mengembalikan objek response penuh; streaming memancarkan event response.* native dan diakhiri response.completed.

Parameters

modelstringbodyrequired

Identifier model (`<public-name>`). Lihat [Katalog Model](/id/docs/api-reference/models).

inputstring | arraybodyrequired

Prompt, baik sebagai string polos maupun array berisi bagian konten.

streambooleanbodyoptionaldefault: false

Set `true` untuk menerima Server-Sent Events. Lihat [Streaming & SSE](/id/docs/api-reference/streaming).

Request Example

curl -X POST "https://api.zrouter.dev/v1/responses" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "<public-name>",
    "input": "Say hello!"
  }'

Responses

200Response berhasil.

{
  "id": "resp_...",
  "object": "response",
  "created_at": 1720000000,
  "model": "<public-name>",
  "output": [
    {
      "type": "message",
      "content": [{ "type": "output_text", "text": "Hello!" }]
    }
  ],
  "usage": { "input_tokens": 8, "output_tokens": 3, "total_tokens": 11 }
}

400`invalid_request` — body salah format atau tidak valid.

401`invalid_api_key` — key hilang, salah, atau dua header bernilai berbeda.

402`insufficient_balance` — saldo Token Plan dan PAYG tidak mencukupi.

404`model_not_found` — identifier model tidak ada atau disembunyikan.

429`technical_limit` — passthrough 429 dari upstream, bukan rate limit zrouter.

502`upstream_error` — penyedia upstream gagal memproses request.

503`overloaded` atau `circuit_open` — kapasitas penuh atau circuit breaker terbuka.

Streaming#

Dengan "stream": true, gateway meneruskan stream event response.* native dari upstream tanpa perubahan. Event terminal response.completed membawa output lengkap (termasuk blok usage final). Contoh lengkap ada di Streaming & SSE.