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

StatusTypeMessageDescription
400invalid_request_errorParamètres de requête requis manquants dans la requête d'URL de téléversementRenvoyé lorsque les paramètres de requête requis sont absents de la requête d'URL de téléversement.
400invalid_request_errorjob_id manquantRenvoyé lorsque la requête de rendu n'inclut pas d'identifiant de job.
400invalid_request_errorAucune sortie disponible pour ce jobRenvoyé lorsque le job n'a aucune sortie pouvant être rendue.
400invalid_request_errorinput_keys doit être un tableau non videRenvoyé lorsque `input_keys` fait défaut ou est vide.
400invalid_request_errorinput_keys doit contenir au moins une clé d'entrée valideRenvoyé lorsque toutes les clés d'entrée fournies sont vides ou invalides après normalisation.
400input_duration_requirement_errorLa durée totale des entrées doit être supérieure à 2 secondesRenvoyé lorsque la durée combinée de tous les médias d'entrée est de 2 secondes ou moins.
400input_duration_requirement_errorLa durée totale des entrées doit être inférieure à 6 heuresRenvoyé lorsque la durée combinée de tous les médias d'entrée est de 6 heures ou plus.
400input_image_count_requirement_errorLe nombre d'images d'entrée ne doit pas dépasser 4000Renvoyé lorsque le nombre d'images d'entrée dépasse la limite maximale autorisée de 4000.
400input_video_count_requirement_errorLe nombre de vidéos d'entrée ne doit pas dépasser 400Renvoyé lorsque le nombre de vidéos d'entrée dépasse la limite maximale autorisée de 400.
400invalid_request_errorvideo_category invalide. Valeurs autorisées : podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, othersRenvoyé lorsque `video_category` n'est pas pris en charge.
400invalid_request_erroraspect_ratio invalide. Valeurs autorisées : square, portrait, landscapeRenvoyé lorsque `aspect_ratio` n'est pas pris en charge.
400invalid_request_erroroutput_length doit être un nombre positifRenvoyé lorsque `output_length` est manquant, nul ou négatif.
400invalid_request_errorImpossible de déterminer une durée d'entrée positive à partir des métadonnées de `input_keys`Renvoyé lorsque l'API ne peut pas déterminer une durée valide pour les entrées téléchargées.
401authentication_errorClé API manquanteRenvoyé lorsque l'en-tête `x-api-key` n'est pas fourni.
401authentication_errorClé API invalideRenvoyé lorsque la clé API fournie ne correspond à aucune clé active.
402insufficient_balanceVous n'avez pas suffisamment de crédits pour traiter ce jobRenvoyé lorsque le compte n'a pas suffisamment de crédits pour le traitement ou le rendu.
403permission_errorVous n'avez pas l'autorisation d'accéder à ce jobRenvoyé lorsque l'utilisateur authentifié n'est pas le propriétaire du job demandé.
403permission_errorVous n'avez pas l'autorisation de rendre ce jobRenvoyé lorsque l'utilisateur authentifié n'est pas le propriétaire du job en cours de rendu.
404invalid_request_errorJob introuvableRenvoyé lorsque le job demandé n'existe pas.
404invalid_request_errorUtilisateur introuvableRenvoyé lorsque l'enregistrement de l'utilisateur authentifié est introuvable.
429rate_limit_errorTrop de requêtesRenvoyé lorsque le client dépasse le taux de requêtes autorisé pour le point de terminaison. La limite actuelle est de 60 requêtes par minute. La limitation de débit est principalement appliquée par clé API en utilisant l'en-tête `x-api-key` et, en l'absence d'une clé API, se rabat sur l'adresse IP du client. 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.
500api_errorErreur d'authentificationRenvoyé lorsque l'authentification par clé API échoue de manière inattendue côté serveur.
500api_errorErreur interne du serveurRenvoyé pour des défaillances inattendues côté serveur dans les endpoints status, render ou highlight reel.
500server_errorÉchec de la génération de l'URL de téléversementRenvoyé lorsque le serveur n'arrive pas à générer une URL de téléversement signée.