Skip to Content

Cancelar video

Cancela una tarea de generación de video en curso. Una tarea solo puede cancelarse mientras sigue ejecutándose: una vez que llega a un estado terminal (completed, failed, cancelled, expired), ya no puede cancelarse.

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

La cancelación depende del proveedor upstream. Ofox acepta una solicitud de cancelación solo cuando el proveedor upstream admite realmente la interrupción: nunca informa un éxito falso marcando la tarea como cancelada localmente mientras upstream sigue generando. Los proveedores que no pueden interrumpir un trabajo en ejecución devuelven 400 cancel_not_supported.

Solicitud

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

Respuesta

Una cancelación exitosa devuelve 204 No Content con el cuerpo vacío.

HTTP/1.1 204 No Content

Después de una cancelación exitosa, el status de la tarea pasa a cancelled. Consultar GET /v1/videos/{id} luego devuelve el estado terminal cancelled, y si registraste un callback_url también recibes un webhook video.generation.cancelled.

Comportamiento de cancelación

Que una cancelación sea aceptada depende del estado actual de la tarea y de si el proveedor upstream admite interrupción:

Estado de la tareaComportamientoRespuesta
pending (aún no enviada upstream)Cancelada localmente204
queued / in_progress, el proveedor admite interrupciónSe llama a la cancelación upstream y luego la tarea se marca como cancelada al tener éxito204
queued / in_progress, el proveedor no admite interrupciónRechazada (sin éxito falso)400 cancel_not_supported
Ya en un estado terminalRechazada400 cancel_failed
No encontrada / no pertenece a tu keyRespuesta unificada (evita revelar existencia)404 not_found

Una tarea que no existe y una tarea propiedad de otra API Key devuelven el mismo 404 not_found, por lo que la respuesta nunca revela si un id de tarea determinado existe.

Errores

HTTPCódigoSignificado
400cancel_not_supportedEl proveedor upstream no admite interrumpir un trabajo en ejecución
400cancel_failedLa tarea ya está en un estado terminal y no puede cancelarse
404not_foundLa tarea no existe o no pertenece a tu API Key

Los errores usan el objeto de error compartido:

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

Consulta la referencia completa de errores para ver todos los códigos. DELETE no está sujeto al límite de tasa de consulta que aplica a GET; ver Obtener estado del video para más detalles.

Last updated on