Erros
A API VIDIO utiliza um formato consistente de objeto de erro. Utilize esta página para entender os 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 Empresariais. Solicite acesso aqui se não for um utilizador Empresarial, mas estiver interessado em utilizar a API.
Visão geral
Quando uma solicitação falha, a API VIDIO retorna um objeto error com um type e 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 | Faltam parâmetros de consulta obrigatórios na solicitação da URL de upload | Retornado quando faltam parâmetros de consulta obrigatórios na solicitação da URL de upload. |
| 400 | invalid_request_error | Falta job_id | Retornado quando a solicitação de renderização não inclui um ID de trabalho. |
| 400 | invalid_request_error | Nenhum output disponível para este trabalho | Retornado quando o trabalho não tem 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 inválidas após a normalização. |
| 400 | invalid_request_error | video_category inválido. Valores permitidos: podcast, desportos com bola, desportos 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 de entrada positiva 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 | Falta 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 | 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 | Não tem permissão para aceder a este trabalho | Retornado quando o utilizador autenticado não é o proprietário do trabalho solicitado. |
| 403 | permission_error | Não tem permissão para renderizar este trabalho | Retornado quando o utilizador autenticado não é o proprietário do trabalho a ser renderizado. |
| 404 | invalid_request_error | Trabalho não encontrado | Retornado quando o trabalho solicitado não existe. |
| 404 | invalid_request_error | Utilizador não encontrado | Retornado quando não é possível encontrar o registo do utilizador autenticado. |
| 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 da API usando o cabeçalho x-api-key, e recai sobre o endereço IP do cliente quando uma chave da API não está presente. Os clientes que atingem este limite devem reduzir a frequência das solicitações e tentar novamente após o período 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 nos endpoints de status, renderização ou reel de destaques. |
| 500 | server_error | Falha ao gerar a URL de upload | Retornado quando o servidor falha ao gerar uma URL de upload assinada. |