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 para o plano Studio e acima.

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	Faltam parâmetros de consulta obrigatórios na solicitação de URL de upload	Retornado quando parâmetros de consulta obrigatórios estão ausentes na solicitação de URL de upload.
400	invalid_request_error	job_id ausente	Retornado quando a solicitação de renderização não inclui um job_id.
400	invalid_request_error	Nenhuma saída disponível para este job	Retornado quando o job não possui saídas renderizáveis.
400	invalid_request_error	input_keys must be a non-empty array	Retornado quando `input_keys` está ausente ou vazio.
400	invalid_request_error	input_keys must contain at least one valid input key	Retornado quando todas as chaves de entrada fornecidas estão em branco ou inválidas após a normalização.
400	input_duration_requirement_error	A duração total das entradas deve ser maior que 2 segundos	Retornado quando a duração combinada de todas as mídias de entrada é de 2 segundos ou menos.
400	input_duration_requirement_error	A duração total das entradas deve ser menor que 6 horas	Retornado quando a duração combinada de todas as mídias de entrada é de 6 horas ou mais.
400	input_image_count_requirement_error	O número de imagens de entrada não pode exceder 4000	Retornado quando o número de imagens de entrada excede o limite máximo permitido de 4000.
400	input_video_count_requirement_error	O número de vídeos de entrada não pode exceder 400	Retornado quando o número de vídeos de entrada excede o limite máximo permitido de 400.
400	invalid_request_error	video_category inválido. Valores permitidos: podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others	Retornado quando `video_category` não é suportado.
400	invalid_request_error	aspect_ratio inválido. Valores permitidos: square, portrait, landscape	Retornado quando `aspect_ratio` não é suportado.
400	invalid_request_error	output_length deve ser um número positivo	Retornado quando `output_length` está ausente, é zero ou negativo.
400	invalid_request_error	Não foi possível determinar uma duração positiva das entradas a partir dos metadados de input_keys	Retornado quando a API não consegue determinar uma duração válida para as entradas carregadas.
400	invalid_request_error	music_volume deve ser um número entre 0 e 100	Retornado quando `music_volume` é fornecido mas não é um número válido entre 0 e 100.
400	invalid_request_error	original_audio_volume deve ser um número entre 0 e 100	Retornado quando `original_audio_volume` é fornecido mas não é um número válido entre 0 e 100.
400	invalid_request_error	music_category inválido. Valores permitidos: corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary, trending_vlogs	Retornado quando `music_category` é fornecido mas não corresponde a uma das categorias de música suportadas.
401	authentication_error	Chave de API ausente	Retornado quando o cabeçalho `x-api-key` não é fornecido.
401	authentication_error	Chave de API inválida	Retornado quando a chave de API fornecida não corresponde a uma chave ativa.
402	insufficient_balance	Você não tem créditos suficientes para processar este job	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 job	Retornado quando o usuário autenticado não é o proprietário do job solicitado.
403	permission_error	Você não tem permissão para renderizar este job	Retornado quando o usuário autenticado não é o proprietário do job sendo renderizado.
404	invalid_request_error	Job não encontrado	Retornado quando o job 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 requisições permitida para o endpoint. O limite atual é de 60 requisições por minuto. A limitação de taxa é aplicada 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 atingirem esse limite devem reduzir a frequência de requisições e tentar novamente após a janela de limite de taxa ser reiniciada.
429	rate_limit_error	Você já possui 10 jobs em execução ou na fila, que é o máximo permitido. Aguarde alguns jobs concluírem antes de enviar outro.	Retornado quando o usuário já possui o número máximo permitido de jobs em andamento, tanto em execução nos servidores quanto pendentes na fila. O limite atual é de 10 jobs em execução ou na fila por usuário. A propriedade é determinada ao verificar cada job_id em servidores ocupados e entradas pendentes na fila em relação ao user_email do job. Clientes que atingirem esse limite devem aguardar que um ou mais jobs existentes sejam concluídos antes de criar ou renderizar outro job.
500	api_error	Erro de autenticação	Retornado quando a autenticação da chave de API falha inesperadamente no servidor.
500	api_error	Erro interno do servidor	Retornado para falhas inesperadas no lado do servidor nos endpoints de status, render ou highlight reel.
500	server_error	Falha ao gerar URL de upload	Retornado quando o servidor não consegue gerar uma URL de upload assinada.