MImirage
Videos

Create Video

Changed on
post/v1/videos

Request

Headers

x-api-keystring required

API Key for authentication

Request body multipart/form-data

audio_referencestring binary required

Driving audio file (WAV or MP3, 1-180 seconds)

image_referencestring binary nullable

Image appearance reference (JPEG or PNG). Exactly one visual reference is required.

video_referencestring binary nullable

Video appearance reference (MP4 or MOV, 10-60 seconds; feature-gated preview). Exactly one visual reference is required.

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

Model to use for generation

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

  • fd2d6a77680eRevision changes
    • breaking

      request property was restricted to a list of enum values

    • 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

    • info

      the request property const value mirage-video-1-latest was removed

    • info

      the request property default value changed from mirage-video-1-latest to mirage-avatar-x

    • info

      added the new mirage-avatar-x enum value to the request property

    • info

      added the new mirage-video-1-latest enum value to the request property

  • 11e1197415cbRevision changes
    • info

      added the new optional request property

    • info

      added subschema #1 subschema #2 to the request body oneOf list

    • info

      the request property became optional

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status