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 tersedia untuk pelan Studio dan lebih tinggi.
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 query yang diperlukan hilang dalam permintaan URL muat naik | Dikembalikan apabila parameter query yang diperlukan hilang dari permintaan URL muat naik. |
| 400 | invalid_request_error | job_id hilang | Dikembalikan apabila permintaan render tidak termasuk ID kerja. |
| 400 | invalid_request_error | Tiada output tersedia untuk pekerjaan ini | Dikembalikan apabila pekerjaan tidak mempunyai sebarang output yang boleh dirender. |
| 400 | invalid_request_error | input_keys must be a non-empty array | Dikembalikan apabila `input_keys` hilang atau kosong. |
| 400 | invalid_request_error | input_keys must contain at least one valid input key | Dikembalikan apabila semua kunci input yang diberikan kosong atau tidak sah selepas penormalan. |
| 400 | input_duration_requirement_error | Total input duration must be greater than 2 seconds | Dikembalikan apabila jumlah durasi semua media input adalah 2 saat atau kurang. |
| 400 | input_duration_requirement_error | Total input duration must be less than 6 hours | Dikembalikan apabila jumlah durasi semua media input adalah 6 jam atau lebih. |
| 400 | input_image_count_requirement_error | Number of input images must be no more than 4000 | Dikembalikan apabila bilangan imej input melebihi had maksimum 4000. |
| 400 | input_video_count_requirement_error | Number of input videos must be no more than 400 | Dikembalikan apabila bilangan video input melebihi had maksimum 400. |
| 400 | invalid_request_error | video_category tidak sah. Nilai dibenarkan: podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others | Dikembalikan apabila `video_category` tidak disokong. |
| 400 | invalid_request_error | aspect_ratio tidak sah. Nilai dibenarkan: square, portrait, landscape | Dikembalikan apabila `aspect_ratio` tidak disokong. |
| 400 | invalid_request_error | output_length mesti merupakan nombor positif | Dikembalikan apabila `output_length` hilang, sifar, atau negatif. |
| 400 | invalid_request_error | Tidak dapat menentukan durasi input positif daripada metadata input_keys | Dikembalikan apabila API tidak dapat menentukan durasi yang sah untuk input yang dimuat naik. |
| 400 | invalid_request_error | music_volume mesti merupakan nombor antara 0 dan 100 | Dikembalikan apabila `music_volume` disediakan tetapi bukan nombor sah antara 0 dan 100. |
| 400 | invalid_request_error | original_audio_volume mesti merupakan nombor antara 0 dan 100 | Dikembalikan apabila `original_audio_volume` disediakan tetapi bukan nombor sah antara 0 dan 100. |
| 400 | invalid_request_error | music_category tidak sah. Nilai dibenarkan: corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary, trending_vlogs | Dikembalikan apabila `music_category` disediakan tetapi tidak sepadan dengan salah satu kategori muzik yang disokong. |
| 401 | authentication_error | Kunci API hilang | Dikembalikan apabila header `x-api-key` tidak disertakan. |
| 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 pekerjaan ini | Dikembalikan apabila akaun tidak mempunyai kredit yang mencukupi untuk pemprosesan atau rendering. |
| 403 | permission_error | Anda tidak mempunyai kebenaran untuk mengakses pekerjaan ini | Dikembalikan apabila pengguna yang diautentikasi tidak memiliki pekerjaan yang diminta. |
| 403 | permission_error | Anda tidak mempunyai kebenaran untuk merender pekerjaan ini | Dikembalikan apabila pengguna yang diautentikasi tidak memiliki pekerjaan yang sedang dirender. |
| 404 | invalid_request_error | Pekerjaan tidak dijumpai | Dikembalikan apabila pekerjaan yang diminta tidak wujud. |
| 404 | invalid_request_error | Pengguna tidak ditemui | Dikembalikan apabila rekod pengguna yang diautentikasi tidak dapat dijumpai. |
| 429 | rate_limit_error | Terlalu banyak permintaan | Dikembalikan apabila klien melebihi kadar permintaan yang dibenarkan untuk endpoint. Had semasa ialah 60 permintaan setiap minit. Pembatasan kadar terutamanya dikenakan per kunci API menggunakan header `x-api-key`, dan kembali kepada alamat IP klien apabila kunci API tidak disertakan. Klien yang mencapai had ini harus mengurangkan kekerapan permintaan dan cuba semula selepas tetingkap had kadar diset semula. |
| 429 | rate_limit_error | Anda sudah mempunyai 10 pekerjaan yang sedang berjalan atau dalam barisan, yang merupakan maksimum dibenarkan. Sila tunggu beberapa pekerjaan selesai sebelum menghantar yang lain. | Dikembalikan apabila pengguna sudah mempunyai bilangan maksimum pekerjaan yang sedang dijalankan mengikut kedua-dua pekerjaan yang sedang berjalan di server dan pekerjaan yang menunggu dalam barisan. Had semasa ialah 10 jumlah pekerjaan yang sedang berjalan atau dalam barisan bagi setiap pengguna. Pemilikan ditentukan dengan memadankan setiap job_id pada server sibuk dan entri barisan yang menunggu kembali kepada user_email kerja itu. Klien yang mencapai had ini harus menunggu satu atau lebih pekerjaan sedia ada selesai sebelum mencipta atau merender pekerjaan lain. |
| 500 | api_error | Ralat pengesahan | Dikembalikan apabila pengesahan kunci API gagal secara tidak dijangka di pelayan. |
| 500 | api_error | Ralat dalaman pelayan | Dikembalikan untuk kegagalan sisi pelayan yang tidak dijangka dalam endpoint status, render, atau highlight reel. |
| 500 | server_error | Gagal menjana URL muat naik | Dikembalikan apabila pelayan gagal menjana URL muat naik yang ditandatangani. |