Skip to main content
GET
/
v1
/
videos
List Videos
curl --request GET \
  --url https://api.mirage.app/v1/videos \
  --header 'x-api-key: <api-key>'
[
  {
    "status": "PROCESSING",
    "id": "<string>",
    "video_id": "<string>",
    "created_at": 123,
    "model": "<string>",
    "object": "video",
    "progress": 100,
    "completed_at": 1730822520,
    "error": null
  }
]

Authorizations

​
x-api-key
string
header
required

API key for authentication.

Query Parameters

​
after
string | null

Return items strictly after this video ID

​
limit
integer
default:20

Max number of items to return

Required range: 1 <= x <= 100
​
order
enum<string>
default:desc

Sort order by creation time

Available options:
asc,
desc

Response

200 - application/json

Successful Response

​
status
enum<string>
required

Current state of video generation

Available options:
PROCESSING,
COMPLETE,
FAILED,
CANCELLED
​
id
string
required

Video generation job ID

​
video_id
string
required

[Deprecated] Use "id" instead.

​
created_at
integer
required

When the job was created (unix timestamp)

​
model
string
required

Model used for generation

Allowed value: "mirage-video-1-latest"
​
object
string
default:video
Allowed value: "video"
​
progress
integer | null

Progress percentage (0-100)

Example:

100

​
completed_at
integer | null

When the job completed (if applicable, unix timestamp)

Example:

1730822520

​
error
MAVideoError · object

Error payload that explains why generation failed, if applicable

Example:

null