Skip to main content
Captions logo
  • Category: ai content generation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 8
  • Triggers: 0
  • Slug: CAPTIONS
  • Version: 00000000_00

Tools

Slug: CAPTIONS_ADD_CAPTIONSStart an asynchronous job that transcribes and renders a selected caption style onto an uploaded or existing completed video. Use CAPTIONS_GET_VIDEO_STATUS to monitor the returned job, then CAPTIONS_DOWNLOAD_VIDEO when it completes. This call consumes paid Mirage credits and cannot be cancelled or deleted once submitted.

Input Parameters

object
MP4 or MOV video upload. The video must use a 9:16 aspect ratio, be at most 50 MB, and be at most 5 minutes long. Provide this or video_id, but not both.
string
ID of an existing COMPLETE video in video_* format. Provide this or video, but not both.
string
required
Caption style template ID returned by CAPTIONS_LIST_CAPTION_TEMPLATES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAPTIONS_DOWNLOAD_VIDEODownload the MP4 content of a completed video job and return an offloaded file reference. Use CAPTIONS_GET_VIDEO_STATUS first to confirm the job is COMPLETE.

Input Parameters

string
required
ID of a completed video in video_* format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAPTIONS_GENERATE_SPEECHGenerate WAV speech synchronously from text using a known Mirage voice ID and return an offloaded audio file reference. This call consumes paid Mirage credits and cannot be cancelled or deleted once submitted.

Input Parameters

string
required
Text to synthesize as speech; must not be empty.
string
required
Mirage voice ID to synthesize with. The public API does not provide a voice-list endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAPTIONS_GENERATE_VIDEOStart an asynchronous Mirage Video 1 job that animates a portrait image using speech audio. Use the returned job ID with CAPTIONS_GET_VIDEO_STATUS. This call consumes paid Mirage credits and cannot be cancelled or deleted once submitted.

Input Parameters

object
required
WAV or MP3 speech audio that drives the portrait animation. Duration must be between 1 and 180 seconds.
object
required
JPEG or PNG portrait image to animate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAPTIONS_GET_CAPTION_TEMPLATERetrieve one caption style by ID, including its name and preview video URL.

Input Parameters

string
required
Caption template ID in ctpl_* format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAPTIONS_GET_VIDEO_STATUSRetrieve the current state, progress, and error details for a video generation or captioning job.

Input Parameters

string
required
Video job ID in video_* format, returned by video generation or captioning.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAPTIONS_LIST_CAPTION_TEMPLATESReturn one page of available caption styles, including names and preview video URLs.

Input Parameters

integer
Maximum caption templates to return on this page (1-100).
string
Continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAPTIONS_LIST_VIDEOSReturn one page of video jobs owned by the connected Mirage account, including each job’s status and progress.

Input Parameters

integer
Maximum videos to return on this page (1-100).
string ("asc" | "desc")
Sort videos by creation time in ascending or descending order.
string
Continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not