Meta Text Overlays

Retrieve Meta Text Overlay

get/v1/meta/text_overlays/{text_overlay_id}

Request

Base URL
https://api.mirage.app (the document declares no server; this is the origin it was published from)
Auth
none declared. Required headers: x-api-key
TypeScript
https://skmtc.dev/mirage/apis/mirage-video-api/docs/v1/meta/text_overlays/:text_overlay_id/get.ts
A function with typed inputs. Its response is checked against the schema.

text_overlay_idstring required

x-api-keystring required

API Key for authentication

Successful Response

idstring required

Text overlay job ID

object'text_overlay'

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

Current state of the text overlay job

created_atinteger required

When the job was created (unix timestamp)

completed_atinteger nullable

When processing reached a terminal state (unix timestamp)

{
  "created_at": 1730822400,
  "id": "d7f76ec6-2500-4d23-a2bc-648f4e904555",
  "object": "text_overlay",
  "results": [],
  "status": "QUEUED"
}

No recorded changes to this operation across all 15 revisions of this API.