Sign in

v2

latestOpenAPI 3.1.02026-07-26232135.9 KB
Meta Text Overlays

Retrieve Meta Text Overlay

get/v1/meta/text_overlays/{text_overlay_id}

Path parameters

text_overlay_idstring required

Headers

x-api-keystring required

API Key for authentication

API Key for authentication

Response

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)

Example response

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