Annuler une vidéo

Annulez une tâche de génération vidéo en cours. Une tâche ne peut être annulée que tant qu’elle est encore en cours — une fois qu’elle atteint un état terminal (completed, failed, cancelled, expired), elle ne peut plus être annulée.


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

L’annulation dépend du fournisseur en amont. Ofox accepte une demande d’annulation uniquement lorsque le fournisseur en amont prend réellement en charge l’interruption — il ne signale jamais un faux succès en marquant la tâche annulée localement pendant que l’amont continue à générer. Les fournisseurs qui ne peuvent pas interrompre une tâche en cours renvoient 400 cancel_not_supported.

Requête

Terminal


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

Réponse

Une annulation réussie renvoie 204 No Content avec un corps vide.


HTTP/1.1 204 No Content

Après une annulation réussie, le status de la tâche devient cancelled. Le polling de GET /v1/videos/{id} renvoie ensuite l’état terminal cancelled, et si vous avez enregistré un callback_url, vous recevez également un webhook video.generation.cancelled.

Comportement d’annulation

L’acceptation d’une annulation dépend de l’état courant de la tâche et de la prise en charge de l’interruption par le fournisseur en amont :

État de la tâche	Comportement	Réponse
`pending` (pas encore soumise en amont)	Annulée localement	`204`
`queued` / `in_progress`, le fournisseur prend en charge l’interruption	L’annulation en amont est appelée, puis la tâche est marquée comme annulée en cas de succès	`204`
`queued` / `in_progress`, le fournisseur ne prend pas en charge l’interruption	Rejetée (pas de faux succès)	`400 cancel_not_supported`
Déjà dans un état terminal	Rejetée	`400 cancel_failed`
Introuvable / non détenue par votre clé	Réponse unifiée (empêche la divulgation d’existence)	`404 not_found`

Une tâche inexistante et une tâche détenue par une autre clé API renvoient le même 404 not_found, de sorte que la réponse ne révèle jamais si un identifiant de tâche donné existe.

Erreurs

HTTP	code	Signification
`400`	`cancel_not_supported`	Le fournisseur en amont ne prend pas en charge l’interruption d’une tâche en cours
`400`	`cancel_failed`	La tâche est déjà dans un état terminal et ne peut pas être annulée
`404`	`not_found`	La tâche n’existe pas, ou elle n’est pas détenue par votre clé API

Les erreurs utilisent l’objet d’erreur partagé :


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

Consultez la référence complète des erreurs pour tous les codes. DELETE n’est pas soumis à la limite de débit de polling qui s’applique à GET — voir Obtenir le statut vidéo pour plus de détails.