Отмена видео

Отменяет выполняющуюся задачу генерации видео. Задачу можно отменить только пока она еще выполняется — после перехода в конечное состояние (completed, failed, cancelled, expired) ее больше нельзя отменить.


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

Отмена зависит от upstream-провайдера. Ofox принимает запрос отмены только когда upstream-провайдер действительно поддерживает прерывание — он никогда не сообщает фиктивный успех, помечая задачу отмененной локально, пока upstream продолжает генерацию. Провайдеры, которые не могут прервать выполняющуюся задачу, возвращают 400 cancel_not_supported.

Запрос

Terminal


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

Ответ

Успешная отмена возвращает 204 No Content с пустым body.


HTTP/1.1 204 No Content

После успешной отмены status задачи становится cancelled. Последующий опрос GET /v1/videos/{id} возвращает конечное состояние cancelled, а если вы зарегистрировали callback_url, вы также получите webhook video.generation.cancelled.

Поведение отмены

Будет ли отмена принята, зависит от текущего состояния задачи и от того, поддерживает ли upstream-провайдер прерывание:

Состояние задачи	Поведение	Ответ
`pending` (еще не отправлена upstream)	Отменяется локально	`204`
`queued` / `in_progress`, провайдер поддерживает прерывание	Вызывается upstream-отмена, затем при успехе задача помечается отмененной	`204`
`queued` / `in_progress`, провайдер не поддерживает прерывание	Отклоняется (без фиктивного успеха)	`400 cancel_not_supported`
Уже в конечном состоянии	Отклоняется	`400 cancel_failed`
Не найдена / не принадлежит вашему ключу	Единый ответ (предотвращает раскрытие существования)	`404 not_found`

Несуществующая задача и задача, принадлежащая другому API key, возвращают одинаковый 404 not_found, поэтому ответ никогда не раскрывает, существует ли данный task id.

Ошибки

HTTP	code	Значение
`400`	`cancel_not_supported`	Upstream-провайдер не поддерживает прерывание выполняющейся задачи
`400`	`cancel_failed`	Задача уже в конечном состоянии и не может быть отменена
`404`	`not_found`	Задача не существует или не принадлежит вашему API key

Ошибки используют общий объект ошибки:


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

Полный справочник ошибок содержит все коды. DELETE не подпадает под лимит опроса, который применяется к GET — подробности см. в Получении статуса видео.