Buat Respons

Hasilkan output model dengan Responses API yang kompatibel dengan OpenAI.

Gunakan bentuk Responses API untuk input model teks atau terstruktur dan objek output terpadu.

POST/openai/v1/responses

Badan Permintaan

BidangTipeWajibDeskripsi
modelstringYaPengenal model yang dirutekan oleh AnyInt.
inputstring atau arrayYaTeks atau item input terstruktur.
streambooleanTidakKembalikan peristiwa yang dikirim server saat didukung.
reasoning.effortstringNoUpaya yang bergantung pada model, diteruskan tanpa pengurangan diam-diam.
toolsarrayNoDeklarasi alat, termasuk alat khusus.

Respons

Permintaan yang selesai mengembalikan objek respons dengan pengenal, status, dan output yang dihasilkan.

Riwayat dan Validasi Alat

Panggilan alat khusus dan output alat multipart mempertahankan urutan dan teks Unicode-nya. Larik annotations dan logprobs kosong disediakan untuk bagian output_text asisten saat dihilangkan atau null, sehingga relai tidak dapat merekonstruksinya sebagai metadata null yang tidak valid. Pesan keep-alive penyedia dikecualikan dari riwayat percakapan.

Dukungan upaya penalaran bergantung pada model dan upstream yang dipilih. Penolakan terstruktur mengidentifikasi bidang tersebut, misalnya error.code: "invalid_value" dan error.param: "reasoning.effort". Penolakan format yang tidak dapat ditemukan atau dihasilkan oleh relai mengembalikan kesalahan upstream daripada mengidentifikasi riwayat klien yang valid sebagai format yang salah.

Streaming dan Pemulihan

Streaming yang berhasil diakhiri dengan response.completed; batas output dapat diakhiri dengan response.incomplete. Kegagalan upstream, batas waktu, atau EOF dini menghasilkan response.failed. Streaming yang gagal tidak menerima terminal sukses palsu atau penanda lawas [DONE]. Periksa peristiwa terminal bahkan saat status HTTP adalah 200. Kegagalan streaming terminal tidak mengizinkan pemutaran ulang otomatis dari pekerjaan yang telah dikirim.

Heartbeat menggunakan komentar SSE. Peristiwa response.metadata penyedia dan item output SSE-Keep-Alive difilter. Nilai sequence_number peristiwa meningkat secara monoton.

Header opsional x-client-message-id dan x-resume-message-id memilih pemulihan offset peristiwa. x-anyint-resume-offset-unit: sse-event menjelaskan offset tersebut; x-anyint-stream-replayed: true mengidentifikasi pemutaran ulang. Klien yang tidak memilih dapat mengabaikan header ekstensi ini.

Alias Kompatibilitas

Klien yang ada dapat terus menggunakan /v1/responses. Integrasi baru harus menggunakan /openai/v1/responses.