Cancelar vídeo

Cancele uma tarefa de geração de vídeo em andamento. Uma tarefa só pode ser cancelada enquanto ainda está em execução — depois que chega a um estado terminal (completed, failed, cancelled, expired), ela não pode mais ser cancelada.


DELETE https://api.ofox.ai/v1/videos/{id}

O cancelamento depende do provedor upstream. A Ofox aceita uma requisição de cancelamento apenas quando o provedor upstream realmente suporta interrupção — ela nunca relata um sucesso falso marcando a tarefa como cancelada localmente enquanto o upstream continua gerando. Provedores que não conseguem interromper uma tarefa em execução retornam 400 cancel_not_supported.

Requisição

Terminal


curl -X DELETE https://api.ofox.ai/v1/videos/9bcf3c60-7db2-4e1a-a1b2-c3d4e5f60718 \
  -H "Authorization: Bearer $OFOX_API_KEY"

Resposta

Um cancelamento bem-sucedido retorna 204 No Content com corpo vazio.


HTTP/1.1 204 No Content

Depois de um cancelamento bem-sucedido, o status da tarefa se torna cancelled. Fazer polling em GET /v1/videos/{id} então retorna o estado terminal cancelled; se você registrou um callback_url, também recebe um webhook video.generation.cancelled.

Comportamento do cancelamento

Se um cancelamento é aceito depende do estado atual da tarefa e de o provedor upstream suportar interrupção:

Estado da tarefa	Comportamento	Resposta
`pending` (ainda não enviada ao upstream)	Cancelada localmente	`204`
`queued` / `in_progress`, provedor suporta interrupção	Cancelamento upstream é chamado, depois a tarefa é marcada como cancelada em caso de sucesso	`204`
`queued` / `in_progress`, provedor não suporta interrupção	Rejeitada (sem sucesso falso)	`400 cancel_not_supported`
Já em estado terminal	Rejeitada	`400 cancel_failed`
Não encontrada / não pertence à sua key	Resposta unificada (impede divulgação de existência)	`404 not_found`

Uma tarefa inexistente e uma tarefa pertencente a outra API key retornam o mesmo 404 not_found, então a resposta nunca revela se um determinado id de tarefa existe.

Erros

HTTP	código	Significado
`400`	`cancel_not_supported`	O provedor upstream não suporta interromper uma tarefa em execução
`400`	`cancel_failed`	A tarefa já está em um estado terminal e não pode ser cancelada
`404`	`not_found`	A tarefa não existe ou não pertence à sua API key

Erros usam o objeto de erro compartilhado:


{
  "error": {
    "code": "cancel_not_supported",
    "message": "The upstream provider for this task does not support cancellation."
  }
}

Veja a referência de erros completa para todos os códigos. DELETE não está sujeito ao limite de taxa de polling aplicado a GET — veja Obter status do vídeo para detalhes.