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

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 no pedido da URL de upload	Retornado quando os parâmetros de consulta obrigatórios estão ausentes no pedido da URL de upload.
400	invalid_request_error	Falta o job_id	Retornado quando o pedido de renderização não inclui um ID do trabalho.
400	invalid_request_error	Não existem saídas disponíveis para este trabalho	Retornado quando o trabalho não tem quaisquer saídas renderizáveis.
400	invalid_request_error	input_keys must be a non-empty array	Retornado quando `input_keys` está em falta 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 normalização.
400	input_duration_requirement_error	Total input duration must be greater than 2 seconds	Retornado quando a duração combinada de todos os media de entrada é de 2 segundos ou menos.
400	input_duration_requirement_error	Total input duration must be less than 6 hours	Retornado quando a duração combinada de todos os media de entrada é de 6 horas ou mais.
400	input_image_count_requirement_error	Number of input images must be no more than 4000	Retornado quando o número de imagens de entrada excede o limite máximo permitido de 4000.
400	input_video_count_requirement_error	Number of input videos must be no more than 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. Allowed values: 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. Allowed values: square, portrait, landscape	Retornado quando `aspect_ratio` não é suportado.
400	invalid_request_error	output_length must be a positive number	Retornado quando `output_length` está em falta, é zero ou negativo.
400	invalid_request_error	Could not determine positive input duration from input_keys metadata	Retornado quando a API não consegue determinar uma duração válida para as entradas carregadas.
400	invalid_request_error	music_volume must be a number between 0 and 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 must be a number between 0 and 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. Allowed values: 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	Falta a chave API	Retornado quando o cabeçalho `x-api-key` não é fornecido.
401	authentication_error	Chave API inválida	Retornado quando a chave 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 que está 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 o registo do utilizador autenticado não pode ser encontrado.
429	rate_limit_error	Demasiados pedidos	Retornado quando o cliente excede a taxa de pedidos permitida para o endpoint. O limite atual é de 60 pedidos por minuto. A limitação de taxa é aplicada principalmente por chave API através do cabeçalho x-api-key, e recai para o endereço IP do cliente quando não existe uma chave API. Clientes que atingirem este limite devem reduzir a frequência de pedidos e voltar a tentar depois de a janela de limitação de taxa reiniciar.
429	rate_limit_error	Já tem 10 trabalhos em execução ou na fila, que é o máximo permitido. Aguarde que alguns trabalhos terminem antes de submeter outro.	Retornado quando o utilizador já atingiu o número máximo permitido de trabalhos em progresso, tanto em execução em servidores como pendentes na fila. O limite atual é de 10 trabalhos em execução ou na fila por utilizador. A propriedade é determinada ao corresponder cada job_id nos servidores ocupados e nas entradas pendentes da fila ao user_email do trabalho. Clientes que atingirem este limite devem aguardar que um ou mais trabalhos existentes sejam concluídos antes de criar ou renderizar outro trabalho.
500	api_error	Erro de autenticação	Retornado quando a autenticação da chave API falha inesperadamente no servidor.
500	api_error	Erro interno do servidor	Retornado para falhas inesperadas no lado do servidor nos endpoints de status, de renderização ou de highlight reel.
500	server_error	Falha ao gerar a URL de upload	Retornado quando o servidor falha ao gerar uma URL de upload assinada.