Virheet
VIDIO API käyttää johdonmukaista virheobjektin formaattia. Käytä tätä sivua ymmärtääksesi tavallisia virhetyyppejä, HTTP-tilakoodeja ja esimerkkiviestejä, joita API palauttaa.
API-käyttö on tällä hetkellä saatavilla Studio-suunnitelmalle ja sitä korkeammille.
Yleiskatsaus
Kun pyyntö epäonnistuu, VIDIO API palauttaa error-objektin, jossa on type ja message. Jotkut virheet voivat myös sisältää lisäkenttiä, jotka auttavat selittämään epäonnistumisen.
Virheformaatti
json
{
"error": {
"type": "invalid_request_error",
"message": "Työtä ei löytynyt"
}
}Virheviite
| Status | Type | Message | Description |
|---|---|---|---|
| 400 | invalid_request_error | Lähetys-URL-pyynnöstä puuttuu vaadittuja kyselyparametreja | Palautetaan, kun lähetys-URL-pyynnöstä puuttuu vaadittavia kyselyparametreja. |
| 400 | invalid_request_error | job_id puuttuu | Palautetaan, kun renderöintipyyntö ei sisällä job ID:tä. |
| 400 | invalid_request_error | Tälle työtehtävälle ei ole saatavilla tulosteita | Palautetaan, kun työtehtävällä ei ole renderöitäviä tulosteita. |
| 400 | invalid_request_error | input_keys:n on oltava ei-tyhjä taulukko | Palautetaan, kun `input_keys` puuttuu tai on tyhjä. |
| 400 | invalid_request_error | input_keys:n on sisällettävä vähintään yksi kelvollinen input key | Palautetaan, kun kaikki annetut `input_keys` ovat tyhjiä tai virheellisiä normalisoinnin jälkeen. |
| 400 | input_duration_requirement_error | Syötteiden yhteenlasketun keston on oltava yli 2 sekuntia | Palautetaan, kun kaikkien syötteiden yhteenlaskettu kesto on 2 sekuntia tai vähemmän. |
| 400 | input_duration_requirement_error | Syötteiden yhteenlasketun keston on oltava alle 6 tuntia | Palautetaan, kun kaikkien syötteiden yhteenlaskettu kesto on 6 tuntia tai enemmän. |
| 400 | input_image_count_requirement_error | Syötekuvien määrän on oltava enintään 4000 | Palautetaan, kun syötekuvien määrä ylittää sallitun enimmäisrajan 4000. |
| 400 | input_video_count_requirement_error | Syötevideoiden määrän on oltava enintään 400 | Palautetaan, kun syötevideoiden määrä ylittää sallitun enimmäisrajan 400. |
| 400 | invalid_request_error | Virheellinen video_category. Sallittuja arvoja: podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others | Palautetaan, kun `video_category` ei ole tuettu. |
| 400 | invalid_request_error | Virheellinen aspect_ratio. Sallittuja arvoja: square, portrait, landscape | Palautetaan, kun `aspect_ratio` ei ole tuettu. |
| 400 | invalid_request_error | output_length:n on oltava positiivinen luku | Palautetaan, kun `output_length` puuttuu, on nolla tai negatiivinen. |
| 400 | invalid_request_error | Positiivista syötteen kestoa ei voitu määrittää `input_keys`-metadatasta | Palautetaan, kun API ei pysty määrittämään kelvollista kestoa ladatuille syötteille. |
| 400 | invalid_request_error | music_volume:n on oltava luku välillä 0–100 | Palautetaan, kun `music_volume` on annettu mutta se ei ole kelvollinen luku välillä 0–100. |
| 400 | invalid_request_error | original_audio_volume:n on oltava luku välillä 0–100 | Palautetaan, kun `original_audio_volume` on annettu mutta se ei ole kelvollinen luku välillä 0–100. |
| 400 | invalid_request_error | Virheellinen music_category. Sallittuja arvoja: corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary, trending_vlogs | Palautetaan, kun `music_category` on annettu mutta se ei vastaa mitään tuetuista musiikkikategorioista. |
| 401 | authentication_error | API-avain puuttuu | Palautetaan, kun `x-api-key`-otsikkoa ei ole annettu. |
| 401 | authentication_error | Virheellinen API-avain | Palautetaan, kun annettu API-avain ei vastaa aktiivista avainta. |
| 402 | insufficient_balance | Tililläsi ei ole riittävästi krediittejä tämän työn käsittelyyn | Palautetaan, kun tilillä ei ole riittävästi krediittejä käsittelyyn tai renderöintiin. |
| 403 | permission_error | Sinulla ei ole oikeuksia käyttää tätä työtä | Palautetaan, kun todennettu käyttäjä ei omista pyydettyä työtä. |
| 403 | permission_error | Sinulla ei ole oikeuksia renderöidä tätä työtä | Palautetaan, kun todennettu käyttäjä ei omista renderöitävää työtä. |
| 404 | invalid_request_error | Työtä ei löydy | Palautetaan, kun pyydettyä työtä ei ole olemassa. |
| 404 | invalid_request_error | Käyttäjää ei löydy | Palautetaan, kun todennetun käyttäjän tietuetta ei löydy. |
| 429 | rate_limit_error | Liian monta pyyntöä | Palautetaan, kun asiakas ylittää kyseiselle päätepisteelle sallitun pyyntönopeuden. Nykyinen raja on 60 pyyntöä minuutissa. Rajoitus kohdistuu ensisijaisesti API-avaimen perusteella käyttämällä `x-api-key`-otsikkoa, ja jos API-avainta ei ole, käytetään asiakkaan IP-osoitetta. Asiakkaiden, jotka saavuttavat tämän rajan, tulisi vähentää pyyntöjen tiheyttä ja yrittää uudelleen rajoitusikkunan nollautumisen jälkeen. |
| 429 | rate_limit_error | Sinulla on jo 10 käynnissä olevaa tai jonossa olevaa työtä, mikä on sallittu enimmäismäärä. Odota, että jotkin työt valmistuvat ennen kuin lähetät uuden. | Palautetaan, kun käyttäjällä on jo sallittu enimmäismäärä käynnissä olevia tai jonossa olevia töitä sekä palvelimilla käynnissä olevien töiden että jonossa odottavien töiden osalta. Nykyinen raja on 10 yhteensä käynnissä tai jonossa olevaa työtä käyttäjää kohti. Omistajuus määritetään vastaamalla kuhunkin `job_id`-kenttään käynnissä olevilla palvelimilla ja jonossa olevissa merkinnöissä takaisin työn `user_email`-kenttään. Asiakkaiden, jotka saavuttavat tämän rajan, tulisi odottaa, että yksi tai useampi olemassa oleva työ valmistuu ennen kuin luovat tai renderöivät uuden työn. |
| 500 | api_error | Autentikointivirhe | Palautetaan, kun API-avaimen todennus epäonnistuu odottamattomasti palvelimella. |
| 500 | api_error | Sisäinen palvelinvirhe | Palautetaan odottamattomista palvelinpuolen virheistä status-, renderöinti- tai highlight reel -päätepisteissä. |
| 500 | server_error | Lähetys-URL:n generointi epäonnistui | Palautetaan, kun palvelin ei pysty generoimaan allekirjoitettua lähetys-URL:ia. |