Erreurs
L'API VIDIO utilise un format d'objet d'erreur cohérent. Utilisez cette page pour comprendre les types d'erreurs courants, les codes d'état HTTP et les messages d'exemple retournés par l'API.
L'accès à l'API est actuellement disponible pour le plan Studio et au-dessus.
Aperçu
Lorsque une requête échoue, l'API VIDIO retourne un objet error avec un type et un message. Certaines erreurs peuvent également inclure des champs supplémentaires pour aider à expliquer l'échec.
Format d'erreur
json
{
"error": {
"type": "invalid_request_error",
"message": "Travail non trouvé"
}
}Référence des erreurs
| Status | Type | Message | Description |
|---|---|---|---|
| 400 | invalid_request_error | Paramètres de requête requis manquants dans la requête d'URL de téléversement | Renvoyé lorsque des paramètres de requête requis sont manquants dans la requête d'URL de téléversement. |
| 400 | invalid_request_error | job_id manquant | Renvoyé lorsque la requête de rendu n'inclut pas d'ID du job. |
| 400 | invalid_request_error | Aucune sortie disponible pour ce job | Renvoyé lorsque le job n'a aucune sortie exploitable pour le rendu. |
| 400 | invalid_request_error | input_keys must be a non-empty array | Renvoyé lorsque `input_keys` est manquant ou vide. |
| 400 | invalid_request_error | input_keys must contain at least one valid input key | Renvoyé lorsque toutes les clés d'entrée fournies sont vides ou invalides après normalisation. |
| 400 | input_duration_requirement_error | La durée totale des entrées doit être supérieure à 2 secondes | Renvoyé lorsque la durée combinée de tous les médias d'entrée est de 2 secondes ou moins. |
| 400 | input_duration_requirement_error | La durée totale des entrées doit être inférieure à 6 heures | Renvoyé lorsque la durée combinée de tous les médias d'entrée est de 6 heures ou plus. |
| 400 | input_image_count_requirement_error | Le nombre d'images d'entrée ne doit pas dépasser 4000 | Renvoyé lorsque le nombre d'images d'entrée dépasse la limite maximale autorisée de 4000. |
| 400 | input_video_count_requirement_error | Le nombre de vidéos d'entrée ne doit pas dépasser 400 | Renvoyé lorsque le nombre de vidéos d'entrée dépasse la limite maximale autorisée de 400. |
| 400 | invalid_request_error | video_category invalide. Valeurs autorisées : podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others | Renvoyé lorsque `video_category` n'est pas pris en charge. |
| 400 | invalid_request_error | aspect_ratio invalide. Valeurs autorisées : square, portrait, landscape | Renvoyé lorsque `aspect_ratio` n'est pas pris en charge. |
| 400 | invalid_request_error | output_length doit être un nombre positif | Renvoyé lorsque `output_length` est manquant, égal à zéro ou négatif. |
| 400 | invalid_request_error | Impossible de déterminer une durée d'entrée positive à partir des métadonnées input_keys | Renvoyé lorsque l'API ne peut pas déterminer une durée valide pour les entrées téléversées. |
| 400 | invalid_request_error | music_volume doit être un nombre entre 0 et 100 | Renvoyé lorsque `music_volume` est fourni mais n'est pas un nombre valide entre 0 et 100. |
| 400 | invalid_request_error | original_audio_volume doit être un nombre entre 0 et 100 | Renvoyé lorsque `original_audio_volume` est fourni mais n'est pas un nombre valide entre 0 et 100. |
| 400 | invalid_request_error | music_category invalide. Valeurs autorisées : corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary, trending_vlogs | Renvoyé lorsque `music_category` est fourni mais ne correspond pas à l'une des catégories musicales prises en charge. |
| 401 | authentication_error | Clé API manquante | Renvoyé lorsque l'en-tête x-api-key n'est pas fourni. |
| 401 | authentication_error | Clé API invalide | Renvoyé lorsque la clé API fournie ne correspond pas à une clé active. |
| 402 | insufficient_balance | Vous n'avez pas suffisamment de crédits pour traiter ce job | Renvoyé lorsque le compte n'a pas assez de crédits pour le traitement ou le rendu. |
| 403 | permission_error | Vous n'avez pas la permission d'accéder à ce job | Renvoyé lorsque l'utilisateur authentifié n'est pas le propriétaire du job demandé. |
| 403 | permission_error | Vous n'êtes pas autorisé à effectuer le rendu de ce job | Renvoyé lorsque l'utilisateur authentifié n'est pas le propriétaire du job en cours de rendu. |
| 404 | invalid_request_error | Job introuvable | Renvoyé lorsque le job demandé n'existe pas. |
| 404 | invalid_request_error | Utilisateur introuvable | Renvoyé lorsque l'enregistrement de l'utilisateur authentifié est introuvable. |
| 429 | rate_limit_error | Trop de requêtes | Renvoyé lorsque le client dépasse le taux de requêtes autorisé pour l'endpoint. La limite actuelle est de 60 requêtes par minute. Le contrôle de débit s'applique principalement par clé API en utilisant l'en-tête x-api-key, et retombe sur l'adresse IP du client lorsqu'aucune clé API n'est présente. Les clients qui atteignent cette limite doivent réduire la fréquence des requêtes et réessayer après la réinitialisation de la fenêtre de limitation. |
| 429 | rate_limit_error | Vous avez déjà 10 jobs en cours ou en file d'attente, ce qui est le maximum autorisé. Veuillez attendre que certains jobs se terminent avant d'en soumettre un autre. | Renvoyé lorsque l'utilisateur a déjà le nombre maximal autorisé de jobs en cours, incluant à la fois les jobs en cours d'exécution sur les serveurs et les jobs en attente dans la file. La limite actuelle est de 10 jobs en cours ou en file par utilisateur. La propriété est déterminée en faisant correspondre chaque job_id sur les serveurs occupés et les entrées de la file d'attente avec le user_email du job. Les clients qui atteignent cette limite doivent attendre qu'un ou plusieurs jobs existants se terminent avant d'en créer ou d'en rendre un autre. |
| 500 | api_error | Erreur d'authentification | Renvoyé lorsque l'authentification par clé API échoue de manière inattendue côté serveur. |
| 500 | api_error | Erreur interne du serveur | Renvoyé pour des erreurs serveur inattendues dans les endpoints status, render ou highlight reel. |
| 500 | server_error | Échec de la génération de l'URL de téléversement | Renvoyé lorsque le serveur ne parvient pas à générer une URL de téléversement signée. |