---
title: "Retrieve Meta Text Overlay"
method: GET
path: "/v1/meta/text_overlays/{text_overlay_id}"
tags: ["Meta Text Overlays"]
---

# Retrieve Meta Text Overlay

`GET /v1/meta/text_overlays/{text_overlay_id}`

## Path parameters

- `text_overlay_id` string, required

## Headers

- `x-api-key` string, required — API Key for authentication

## Response `200`

Successful Response

- MetaTextOverlay — Represents a Meta text overlay job.
  - `id` string, required — Text overlay job ID
  - `object` 'text_overlay'
  - `status` 'QUEUED' | 'PROCESSING' | 'COMPLETE' | 'FAILED' | 'CANCELLED', required — Current state of the text overlay job
  - `created_at` integer, required — When the job was created (unix timestamp)
  - `completed_at` integer, nullable — When processing reached a terminal state (unix timestamp)
  - `results` MetaTextOverlayResult[] — Ordered per-text render results for this job
    - `index` integer, required — Zero-based index matching the input texts order
    - `text` string, required — Input text for this rendered output
    - `status` 'COMPLETE' | 'FAILED', required — Terminal status for this item
    - `video_url` string, nullable — Resolved output video URL when this item completed successfully
    - `error` MAVideoError — Error payload that explains why generation failed, if applicable
      - `code` string, required — Error code
      - `message` string, required — Error message
  - `error` MAVideoError — Error payload that explains why generation failed, if applicable
    - `code` string, required — Error code
    - `message` string, required — Error message

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/mirage/apis/mirage-video-api.md) · [All operations](https://skmtc.net/mirage/apis/mirage-video-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mirage/mirage-video-api/versions/302cafad9d70/schema)