Kesalahan

Reigniter API menggunakan kode status HTTP standar. Setiap respons kesalahan adalah JSON.

Badan kesalahan

Sebagian besar kesalahan terlihat seperti ini:

{
  "error": "Rate limit exceeded",
  "code": "RATE_LIMITED",
  "retryAfter": 37
}

Lapangan	Selalu hadir	Apa itu
`error`	Ya	Pesan yang bisa Anda tunjukkan kepada seseorang. Pesan tersebut mungkin mengubah kata, jadi jangan cocokkan di sana.
`code`	Sebagian besar kesalahan	Kode kapital yang stabil. Cabang ini.
`details`	Beberapa kesalahan	Konteks tambahan, misalnya angka `retryAfter` atau penggunaan.
`retryAfter`	Beberapa `429`	Beberapa detik untuk menunggu sebelum mencoba lagi.

Beberapa kesalahan tidak memiliki code, seperti 404 Job not found dan 403 Forbidden. Cabang pada status untuk kesalahan tersebut.

Kesalahan validasi

Ketika badan permintaan tidak sesuai dengan skema, Anda akan mendapatkan 400 dengan string detail yang mencantumkan setiap masalah sebagai field: message:

{
  "error": "Validation failed",
  "detail": "aspect: Invalid option: expected one of \"9:16\"|\"16:9\"|\"1:1\"|\"4:5\"|\"4:3\"|\"3:4\""
}

Kode status

Status	Makna	Apa yang harus dilakukan
`200`	Berhasil.
`201`	Dibuat (webhook).
`202`	Diterima. Render sudah dimulai.	Lakukan polling pekerjaan atau tunggu webhook.
`400`	Permintaan itu ditolak. Tidak ada dakwaan.	Perbaiki permintaan. Jangan coba ulang tanpa perubahan.
`401`	Kunci API hilang, tidak valid, atau dicabut.	Periksa kuncinya.
`402`	Masalah rencana, kredit, atau penggunaan.	Baca `code`.
`403`	Akun yang ditangguhkan, atau pekerjaan yang bukan milik Anda.	Hubungi dukungan, atau periksa ID pekerjaan.
`404`	Tidak ditemukan.	Periksa ID atau jalurnya.
`409`	Permintaan duplikat atau batas tercapai.	Baca `code`.
`413`	Render ini akan lebih mahal dari batas per render.	Gunakan lebih sedikit adegan atau `quality` yang lebih rendah.
`422`	Render tidak memiliki merek, produk, atau presenter untuk menambatkannya.	Lihat membuat video.
`429`	Terlalu banyak permintaan atau terlalu banyak render sekaligus.	Tunggu dan coba lagi. Lihat Batasan.
`500`	Ada sesuatu yang salah di pihak kami.	Coba lagi nanti.
`502`	Perencanaan dari brief Anda gagal. Kredit perencanaan dikembalikan.	Coba ulang, atau ubah formulir singkatnya.
`503`	Rendering sedang dijeda atau layanan sedang down. Tidak ada yang dikenakan biaya.	Coba lagi nanti.

Jalur yang tidak dikenal di bawah /v1/ mengembalikan 404 dengan code: "NOT_FOUND".

Kode kesalahan

Otentikasi dan rencana

Kode	Status	Makna
`NO_API_KEY`	401	Tidak ada header `Authorization`, atau token tidak dimulai dengan `emp_`.
`INVALID_API_KEY`	401	Kunci tidak diketahui atau dicabut.
`PLAN_UPGRADE_REQUIRED`	402	API akses membutuhkan rencana Agency.
`ACCOUNT_SUSPENDED`	403	Akun tersebut ditangguhkan.

Kredit dan penggunaan

Kode	Status	Makna
`NO_CREDITS`	402	Akun tersebut tidak memiliki kredit tersisa.
`INSUFFICIENT_CREDITS`	402	Tidak cukup kredit untuk render ini.
`ABUSE_CAP_EXCEEDED`	402	Batas penggunaan bulanan untuk paket ini telah tercapai.
`STORAGE_FULL`	402	Perpustakaan video akun penuh. Hapus beberapa video.
`UPGRADE_REQUIRED`	402	Video membutuhkan paket berbayar.
`REQUEST_COST_TOO_HIGH`	413	Satu render ini akan lebih mahal dari batas per render.

Lihat Akun dan penagihan untuk kredit dan paket.

Permintaan render

Kode	Status	Makna
`CONTENT_BLOCKED`	400	Brief atau adegan melanggar aturan konten.
`PRODUCT_IMAGE_REQUIRED`	400	Format ini membutuhkan `product_image_url`, atau `product_enabled: false`.
`PRESENTER_REQUIRED`	400	Adegan bicara tidak punya wajah. Tambahkan `avatar_preset_id`, atau kirim `presenter_enabled: false`.
`UNSUPPORTED_MODEL`	400	Sebuah scene meminta model render yang tidak bisa Reigniter gunakan.
`BRAND_REQUIRED`	422	Merek diminta tapi tidak ditemukan. Kirim `brand_logo_url`.
`NO_ANCHOR`	422	Tidak ada merek, foto produk, atau presenter. Tambahkan satu, atau keluarkan diri.
`CANVAS_NOT_FOUND`	404	Proyek yang direferensikan tidak termasuk dalam akun ini.
`DUPLICATE_REQUEST`	409	`Idempotency-Key` ini sudah digunakan. Tidak ada yang baru didakwa.
`PLAN_FAILED`	502	Perencanaan dari brief gagal. Kredit perencanaan dikembalikan.

Dengan brief, Idempotency-Key berulang juga bisa muncul sebagai 402 dengan pesan This request was already submitted. Anggap sebagai duplikat, bukan masalah kredit.

Kurs dan konkurensi

Kode	Status	Makna
`RATE_LIMITED`	429	Terlalu banyak permintaan. Tunggu `retryAfter` (atau `details.retryAfter`) detik.
`CONCURRENT_LIMIT`	429	Terlalu banyak render berjalan sekaligus. Tunggu satu selesai.

Pelayanan

Kode	Status	Makna
`USAGE_CHECK_UNAVAILABLE`	503	Penggunaan tidak dapat diperiksa, sehingga rendering dijeda. Tidak ada yang dikenakan biaya.
`DB_UNAVAILABLE`	503	Sebuah layanan tidak tersedia untuk sementara waktu.
`FEATURE_NOT_AVAILABLE`	503	Rendering saat ini belum tersedia.
`GLOBAL_KILL_SWITCH`	503	Rendering akan dipause untuk semua orang.
`FEATURE_KILL_SWITCH`	503	Fitur ini sedang dijeda.
`USER_KILL_SWITCH`	503	Akun ini dibatasi sementara. Hubungi dukungan.

Webhook

Kode	Status	Makna
`UNKNOWN_EVENT`	400	Bukan acara yang bisa Anda langgani. Respons mencantumkan acara yang valid.
`URL_NOT_DELIVERABLE`	400	URL tersebut bukan alamat http publik.
`HOOK_LIMIT`	409	Akun tersebut sudah memiliki jumlah webhook maksimum.

Mencoba ulang dengan aman

Coba ulang 429, 500, 502 dan 503 dengan backoff. Jangan coba lagi 4xx lain tanpa perubahan.
Selalu kirim Idempotency-Key di POST /v1/render.
Tidak ada respons sama sekali (timeout atau koneksi putus): coba ulang dengan kunci yang sama. Jika permintaan pertama memulai render, percobaan ulang ditolak alih-alih memulai yang kedua.
Respons kesalahan: tidak ada render yang dimulai untuk permintaan tersebut. Perbaiki penyebabnya, lalu coba ulang dengan kunci baru, karena permintaan yang gagal di tengah jalan mungkin sudah menggunakan kuncinya. Kredit render akan dikembalikan. Satu biaya yang tidak dikembalikan adalah perencanaan singkat, ketika render yang direncanakan kemudian ditolak (lihat Membuat video).
Jika render diterima (202) dan kemudian gagal, status pekerjaan menjadi failed dan error menjelaskan alasannya. Kredit untuk pekerjaan yang tidak terjadi akan dikembalikan.