Videos

Create Video

post/v1/videos

Headers

x-api-keystring required

API Key for authentication

Response

Returns a Video object representing the generation job

idstring required

Video generation job ID

object'video'

status'PROCESSING' | 'COMPLETE' | 'FAILED' | 'CANCELLED' required

Current state of the video

created_atinteger required

When the video was created (unix timestamp)

completed_atinteger nullable

When processing completed (unix timestamp)

progressinteger nullable

Progress percentage (0-100)

model'mirage-avatar-x' | 'mirage-video-1-latest' nullable

Model used for generation (only for source='generation')

generation_mode'image_to_video' | 'video_to_video' nullable

Generation mode resolved from the submitted inputs

aspect_ratio'9:16' | '16:9' nullable

Output aspect ratio resolved from the visual reference

source_video_idstring nullable

The input video that was captioned (only for source='caption')

caption_template_idstring nullable

Caption style template used (only for source='caption')

share_link_urlstring nullable

Public share link for a completed internal video, when enabled.

video_idstring required

[Deprecated] Use "id" instead.

Example response

{
  "completed_at": 1730822520,
  "created_at": 1730822400,
  "model": "mirage-avatar-x",
  "progress": 100,
  "status": "COMPLETE",
  "video_id": "video_abc123def456"
}

Changes

Changed in 3 of the 14 revisions of this API.3210

Aug 12, 2026fd2d6a77680e224See the full diff
- ▲
  request property was restricted to a list of enum values
  request-property-became-enum
- ▲
  the response property const value mirage-video-1-latest was removed for the status
  response-property-const-removed
- ●
  added the new mirage-avatar-x enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new mirage-video-1-latest enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  the request property const value mirage-video-1-latest was removed
  request-property-const-removed
- ○
  the request property default value changed from mirage-video-1-latest to mirage-avatar-x
  request-property-default-value-changed
- ○
  added the new mirage-avatar-x enum value to the request property
  request-property-enum-value-added
- ○
  added the new mirage-video-1-latest enum value to the request property
  request-property-enum-value-added
Aug 11, 202611e1197415cb5See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added subschema #1 subschema #2 to the request body oneOf list
  request-body-one-of-added
- ○
  the request property became optional
  request-property-became-optional
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 26, 20260daaa2ae7e3b11See the full diff
- ▲
  the request property contentMediaType changed from application/octet-stream to
  request-property-content-media-type-changed
- ○
  request property list-of-types was widened by adding types null to media type multipart/form-data
  request-property-list-of-types-widened

Full history