MImirage
Videos

Retrieve Video

Changed on

Get the status of a video.

get/v1/videos/{video_id}

Request

Path parameters

video_idstring required

Headers

x-api-keystring required

API Key for authentication

Response

Returns a Video object with the current generation status

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

  • fd2d6a77680eRevision changes
    • breaking

      the response property const value mirage-video-1-latest was removed for the status

    • warning

      added the new mirage-avatar-x enum value to the / response property for the response status

    • warning

      added the new mirage-video-1-latest enum value to the / response property for the response status

  • 11e1197415cbRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status