Skip to main content
POST
/
movies
/
{movie_id}
/
cancel
Cancel a movie
curl --request POST \
  --url https://api.keyframe.art/v1/movies/{movie_id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "prompt": "<string>",
  "duration_seconds": 123,
  "progress": {
    "percent": 50,
    "stage": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
movie_id
string
required

Movie ID.

Pattern: ^movie_[A-Za-z0-9]+$

Response

Movie canceled or already terminal.

​
id
string
required
Example:

"movie_abc123"

​
status
enum<string>
required
Available options:
queued,
planning,
generating,
rendering,
completed,
failed,
canceled
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
prompt
string
​
duration_seconds
integer
​
aspect_ratio
enum<string>
Available options:
16:9,
9:16,
1:1,
4:5
​
progress
object
​
error
object