Ralat
API VIDIO menggunakan format objek ralat yang konsisten. Gunakan halaman ini untuk memahami jenis ralat umum, kod status HTTP, dan contoh mesej yang dikembalikan oleh API.
Akses API kini hanya tersedia untuk pelan Enterprise sahaja. Minta akses di sini jika anda bukan pengguna Enterprise tetapi berminat untuk menggunakan API.
Gambaran Keseluruhan
Apabila permintaan gagal, API VIDIO mengembalikan objek error dengan type dan message. Beberapa ralat mungkin juga menyertakan bidang tambahan untuk membantu menjelaskan kegagalan.
Format ralat
json
{
"error": {
"type": "invalid_request_error",
"message": "Kerja tidak ditemui"
}
}Rujukan ralat
| Status | Type | Message | Description |
|---|---|---|---|
| 400 | invalid_request_error | Parameter pertanyaan yang diperlukan hilang dalam permintaan URL muat naik | Dikembalikan apabila parameter pertanyaan yang diperlukan hilang dari permintaan URL muat naik. |
| 400 | invalid_request_error | Job_id hilang | Dikembalikan apabila permintaan render tidak menyertakan ID kerja. |
| 400 | invalid_request_error | Tiada hasil tersedia untuk kerja ini | Dikembalikan apabila kerja tidak mempunyai sebarang hasil yang boleh dirender. |
| 400 | invalid_request_error | input_keys mesti menjadi array yang tidak kosong | Dikembalikan apabila `input_keys` hilang atau kosong. |
| 400 | invalid_request_error | input_keys mesti mengandungi sekurang-kurangnya satu kunci input yang sah | Dikembalikan apabila semua kunci input yang diberikan kosong atau tidak sah selepas normalisasi. |
| 400 | invalid_request_error | video_category tidak sah. Nilai yang dibenarkan: podcast, bola-sukan, bukan-bola-sukan, demo-produk-kecantikan, perkahwinan, perjalanan, lain-lain | Dikembalikan apabila `video_category` tidak disokong. |
| 400 | invalid_request_error | aspect_ratio tidak sah. Nilai yang dibenarkan: persegi, potret, landskap | Dikembalikan apabila `aspect_ratio` tidak disokong. |
| 400 | invalid_request_error | output_length mesti menjadi nombor positif | Dikembalikan apabila `output_length` hilang, sifar, atau negatif. |
| 400 | invalid_request_error | Tidak dapat menentukan durasi input positif dari metadata input_keys | Dikembalikan apabila API tidak dapat menentukan durasi yang sah untuk input yang dimuat naik. |
| 401 | authentication_error | Kunci API hilang | Dikembalikan apabila header `x-api-key` tidak disediakan. |
| 401 | authentication_error | Kunci API tidak sah | Dikembalikan apabila kunci API yang diberikan tidak sepadan dengan kunci aktif. |
| 402 | insufficient_balance | Anda tidak mempunyai kredit yang mencukupi untuk memproses kerja ini | Dikembalikan apabila akaun tidak mempunyai kredit yang cukup untuk pemprosesan atau rendering. |
| 403 | permission_error | Anda tidak mempunyai kebenaran untuk mengakses kerja ini | Dikembalikan apabila pengguna yang disahkan tidak memiliki kerja yang diminta. |
| 403 | permission_error | Anda tidak mempunyai kebenaran untuk merender kerja ini | Dikembalikan apabila pengguna yang disahkan tidak memiliki kerja yang sedang dirender. |
| 404 | invalid_request_error | Kerja tidak ditemui | Dikembalikan apabila kerja yang diminta tidak wujud. |
| 404 | invalid_request_error | Pengguna tidak ditemui | Dikembalikan apabila rekod pengguna yang disahkan tidak dapat ditemui. |
| 429 | rate_limit_error | Terlalu banyak permintaan | Dikembalikan apabila klien melebihi kadar permintaan yang dibenarkan untuk titik akhir. Had semasa adalah 60 permintaan setiap minit. Had kadar dikenakan terutamanya berdasarkan kunci API menggunakan header x-api-key, dan akan menggunakan alamat IP klien apabila kunci API tidak hadir. Klien yang mencapai had ini harus mengurangkan kekerapan permintaan dan mencuba semula selepas tingkap had kadar diset semula. |
| 500 | api_error | Ralat pengesahan | Dikembalikan apabila pengesahan kunci API gagal dengan tidak disangka di pelayan. |
| 500 | api_error | Ralat pelayan dalaman | Dikembalikan untuk kegagalan yang tidak dijangka di pihak pelayan dalam status, render, atau titik akhir sorotan. |
| 500 | server_error | Gagal menjana URL muat naik | Dikembalikan apabila pelayan gagal menjana URL muat naik yang ditandatangani. |