OhMyGPT
Videos

Cancel video

POST
/v1/videos/{id}/cancel

Cancel a job that is still queued; a cancelled job is not charged. Models whose provider cannot cancel answer 501, and a job already being generated answers 409.

Authorization

ApiKeyAuth
headerAuthorization<token>

Path Parameters

id*string

The id of a video job.

Response Body

The cancelled job

application/json
  1. response
created_at*string
Formatdate-time
error?

Why the job failed

finished_at?string
Formatdate-time
id*string
model*string
object*"video"
Value in"video"
progress*integer

Percent done, as far as the provider reports it

Range0 <= value <= 100
result_available*boolean

Whether GET /v1/videos/{id}/content can download the video now

result_url_expires_at?string

When the download stops being available

Formatdate-time
seconds*integer
size*string
status*string

creating until the provider accepts the job; completed, failed and cancelled are final.

Value in"creating""queued""in_progress""completed""failed""cancelled"
updated_at*string
Formatdate-time
Example Request
curl -X POST 'https://api.ohmygpt.com/v1/videos/string/cancel'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "error": {    "code": "string",    "message": "string"  },  "finished_at": "2019-08-24T14:15:22Z",  "id": "string",  "model": "string",  "object": "video",  "progress": 0,  "result_available": true,  "result_url_expires_at": "2019-08-24T14:15:22Z",  "seconds": 0,  "size": "string",  "status": "creating",  "updated_at": "2019-08-24T14:15:22Z"}