Erros
A API VIDIO utiliza um formato consistente de objeto de erro. Use esta página para entender tipos comuns de erro, códigos de status HTTP e mensagens de exemplo retornadas pela API.
O acesso à API está atualmente disponível apenas para planos Enterprise. Solicite acesso aqui se você não for um usuário Enterprise, mas estiver interessado em usar a API.
Visão geral
Quando uma solicitação falha, a API VIDIO retorna um objeto error com um type e um message. Alguns erros podem também incluir campos adicionais para ajudar a explicar a falha.
Formato de erro
json
{
"error": {
"type": "invalid_request_error",
"message": "Trabalho não encontrado"
}
}Referência de erro
| Status | Type | Message | Description |
|---|---|---|---|
| 400 | invalid_request_error | Faltando parâmetros de consulta obrigatórios na solicitação da URL de upload | Retornado quando parâmetros de consulta obrigatórios estão faltando na solicitação da URL de upload. |
| 400 | invalid_request_error | Faltando job_id | Retornado quando a solicitação de renderização não inclui um ID de trabalho. |
| 400 | invalid_request_error | Nenhuma saída disponível para este trabalho | Retornado quando o trabalho não possui saídas renderizáveis. |
| 400 | invalid_request_error | input_keys deve ser um array não vazio | Retornado quando `input_keys` está faltando ou vazio. |
| 400 | invalid_request_error | input_keys deve conter pelo menos uma chave de entrada válida | Retornado quando todas as chaves de entrada fornecidas estão em branco ou são inválidas após a normalização. |
| 400 | invalid_request_error | video_category inválido. Valores permitidos: podcast, esportes de bola, esportes sem bola, demonstração de produto de beleza, casamento, viagem, outros | Retornado quando `video_category` não é suportado. |
| 400 | invalid_request_error | aspect_ratio inválido. Valores permitidos: quadrado, retrato, paisagem | Retornado quando `aspect_ratio` não é suportado. |
| 400 | invalid_request_error | output_length deve ser um número positivo | Retornado quando `output_length` está faltando, é zero ou negativo. |
| 400 | invalid_request_error | Não foi possível determinar a duração positiva da entrada a partir dos metadados de input_keys | Retornado quando a API não consegue determinar uma duração válida para as entradas carregadas. |
| 401 | authentication_error | Faltando chave da API | Retornado quando o cabeçalho `x-api-key` não é fornecido. |
| 401 | authentication_error | Chave da API inválida | Retornado quando a chave da API fornecida não corresponde a uma chave ativa. |
| 402 | insufficient_balance | Você não tem créditos suficientes para processar este trabalho | Retornado quando a conta não tem créditos suficientes para processamento ou renderização. |
| 403 | permission_error | Você não tem permissão para acessar este trabalho | Retornado quando o usuário autenticado não possui o trabalho solicitado. |
| 403 | permission_error | Você não tem permissão para renderizar este trabalho | Retornado quando o usuário autenticado não possui o trabalho que está sendo renderizado. |
| 404 | invalid_request_error | Trabalho não encontrado | Retornado quando o trabalho solicitado não existe. |
| 404 | invalid_request_error | Usuário não encontrado | Retornado quando o registro do usuário autenticado não pode ser encontrado. |
| 429 | rate_limit_error | Muitas solicitações | Retornado quando o cliente excede a taxa de solicitação permitida para o endpoint. O limite atual é de 60 solicitações por minuto. O limite de taxa é aplicado principalmente por chave de API usando o cabeçalho x-api-key e recai sobre o endereço IP do cliente quando uma chave de API não está presente. Clientes que atingem esse limite devem reduzir a frequência das solicitações e tentar novamente após o intervalo de limite de taxa ser redefinido. |
| 500 | api_error | Erro de autenticação | Retornado quando a autenticação da chave da API falha inesperadamente no servidor. |
| 500 | api_error | Erro interno do servidor | Retornado para falhas inesperadas do lado do servidor em status, renderização ou endpoints de destaques. |
| 500 | server_error | Falha ao gerar URL de upload | Retornado quando o servidor falha em gerar uma URL de upload assinada. |