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

StatusTypeMessageDescription
400invalid_request_errorFaltam parâmetros de consulta obrigatórios na solicitação da URL de uploadRetornado quando faltam parâmetros de consulta obrigatórios na solicitação da URL de upload.
400invalid_request_errorFalta job_idRetornado quando a solicitação de renderização não inclui um ID de trabalho.
400invalid_request_errorNenhum output disponível para este trabalhoRetornado quando o trabalho não tem saídas renderizáveis.
400invalid_request_errorinput_keys deve ser um array não vazioRetornado quando `input_keys` está faltando ou vazio.
400invalid_request_errorinput_keys deve conter pelo menos uma chave de entrada válidaRetornado quando todas as chaves de entrada fornecidas estão em branco ou inválidas após a normalização.
400invalid_request_errorvideo_category inválido. Valores permitidos: podcast, desportos com bola, desportos sem bola, demonstração de produto de beleza, casamento, viagem, outrosRetornado quando `video_category` não é suportado.
400invalid_request_erroraspect_ratio inválido. Valores permitidos: quadrado, retrato, paisagemRetornado quando `aspect_ratio` não é suportado.
400invalid_request_erroroutput_length deve ser um número positivoRetornado quando `output_length` está faltando, zero ou negativo.
400invalid_request_errorNão foi possível determinar a duração de entrada positiva a partir dos metadados de input_keysRetornado quando a API não consegue determinar uma duração válida para as entradas carregadas.
401authentication_errorFalta chave da APIRetornado quando o cabeçalho `x-api-key` não é fornecido.
401authentication_errorChave da API inválidaRetornado quando a chave da API fornecida não corresponde a uma chave ativa.
402insufficient_balanceNão tem créditos suficientes para processar este trabalhoRetornado quando a conta não tem créditos suficientes para processamento ou renderização.
403permission_errorNão tem permissão para aceder a este trabalhoRetornado quando o utilizador autenticado não é o proprietário do trabalho solicitado.
403permission_errorNão tem permissão para renderizar este trabalhoRetornado quando o utilizador autenticado não é o proprietário do trabalho a ser renderizado.
404invalid_request_errorTrabalho não encontradoRetornado quando o trabalho solicitado não existe.
404invalid_request_errorUtilizador não encontradoRetornado quando não é possível encontrar o registo do utilizador autenticado.
429rate_limit_errorMuitas solicitaçõesRetornado 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.
500api_errorErro de autenticaçãoRetornado quando a autenticação da chave da API falha inesperadamente no servidor.
500api_errorErro interno do servidorRetornado para falhas inesperadas do lado do servidor nos endpoints de status, renderização ou reel de destaques.
500server_errorFalha ao gerar a URL de uploadRetornado quando o servidor falha ao gerar uma URL de upload assinada.