> ## Documentation Index > Fetch the complete documentation index at: https://www.tella.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # List text overlays on a clip > Returns the text overlays on a clip. ## OpenAPI ````yaml /openapi.json get /v1/videos/{id}/clips/{clipId}/text-overlays openapi: 3.0.3 info: description: >- The Tella Public API allows you to programmatically access your videos and playlists, including transcripts, chapters, and thumbnails. ## Authentication All requests require a Bearer token in the Authorization header: ``` Authorization: Bearer tella_pk_xxxxx... ``` API keys can be generated in your Tella workspace settings. ## Rate Limiting The API is rate-limited to 100 requests per minute per organization. Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets title: Tella Public API version: 1.0.0 servers: - description: Production url: https://api.tella.com security: [] tags: - description: Video operations name: Videos - description: Sections of a video name: Clips - description: Playlist operations name: Playlists - description: Sidebar groups for organizing playlists name: Playlist Groups - description: Tags for categorizing and filtering videos name: Tags - description: Personal, workspace, and default video backgrounds name: Backgrounds - description: >- Reusable media saved to a workspace, plus Tella's curated sound effect catalog — the same items the editor's media panels show name: Library - description: Webhook endpoint management name: Webhooks paths: /v1/videos/{id}/clips/{clipId}/text-overlays: get: tags: - Clips summary: List text overlays on a clip description: Returns the text overlays on a clip. operationId: listClipTextOverlays parameters: - description: Video identifier in: path name: id required: true schema: description: Video identifier example: vid_abc123def456 type: string - description: Clip identifier in: path name: clipId required: true schema: description: Clip identifier example: cl_xyz789ghi012 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListClipTextOverlaysResponse' description: OK '400': $ref: '#/components/responses/400ErrorResponse' '401': $ref: '#/components/responses/401ErrorResponse' '403': $ref: '#/components/responses/403ErrorResponse' '404': $ref: '#/components/responses/404ErrorResponse' '422': $ref: '#/components/responses/422ErrorResponse' '429': $ref: '#/components/responses/429ErrorResponse' '500': $ref: '#/components/responses/500ErrorResponse' security: - BearerAuth: [] components: schemas: ListClipTextOverlaysResponse: additionalProperties: false description: Text overlays on a clip properties: textOverlays: items: $ref: '#/components/schemas/ClipTextOverlay' type: array required: - textOverlays type: object ClipTextOverlay: additionalProperties: false description: >- A text overlay on a clip. Unlike image and video overlays it references no source — the copy and its font live on the overlay itself. properties: background: allOf: - $ref: '#/components/schemas/TextOverlayBackgroundOutput' description: >- Background behind the text. Overlays with no visible box report a solid #00000000. backgroundShape: $ref: '#/components/schemas/TextOverlayBackgroundShape' color: description: >- Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA. example: '#FFFFFFFF' pattern: ^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$ type: string dimensions: $ref: '#/components/schemas/OverlayDimensionsOutput' durationMs: example: 5000 minimum: 0 type: number fontFamily: description: >- The overlay's font family. Normally one of the catalog families accepted on write, but overlays created before that catalog can report another bundled family, such as `Graphik`. example: Inter type: string fontSize: description: >- Font size in artboard pixels — absolute, like `dimensions`, so text keeps its size relative to the frame. Renderers scale it by their render scale factor. example: 81 exclusiveMinimum: true minimum: 0 type: number fontWeight: description: Variable-font weight axis — 100 (thin) to 900 (black). example: 500 type: number fontWidth: description: >- Variable-font width axis, as a percentage — 100 is normal, 50 ultra-condensed, 150 extra-expanded. example: 100 type: number id: description: Text overlay ID example: ly_abc123 type: string point: $ref: '#/components/schemas/OverlayPointOutput' startTimeMs: description: >- Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript. example: 1000 minimum: 0 type: number text: example: Welcome back type: string textAlign: $ref: '#/components/schemas/TextOverlayTextAlign' required: - id - text - fontFamily - fontSize - color - fontWeight - fontWidth - textAlign - background - backgroundShape - startTimeMs - durationMs - point - dimensions type: object ErrorResponse: additionalProperties: false description: Standard error response format properties: error: additionalProperties: false description: Error details properties: code: description: Machine-readable error code enum: - bad_request - unauthorized - forbidden - not_found - unprocessable_entity - rate_limit_exceeded - internal_server_error example: not_found type: string doc_url: description: Link to documentation for this error example: https://tella.tv/docs/api-reference/errors#not-found format: uri type: string message: description: Human-readable error message example: The requested resource was not found. type: string required: - code - message - doc_url type: object required: - error type: object TextOverlayBackgroundOutput: additionalProperties: false description: >- Background behind a text overlay, in the same object shape as a clip background. properties: color: description: >- Hex color string. Required when type = 'solid'. Transparent backgrounds use #00000000. example: '#5E51F8FF' pattern: ^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$ type: string type: description: >- Background variant. Text overlays take a solid background; the other `ClipBackground` variants are not supported behind text. enum: - solid example: solid type: string required: - type - color type: object TextOverlayBackgroundShape: description: Shape of the solid background behind the text. enum: - none - regular - squircle example: squircle type: string OverlayDimensionsOutput: additionalProperties: false description: >- Overlay size in artboard pixels. Absolute (not a percentage) so the overlay shape never distorts when the artboard dimensions change. Both sides must be greater than 0 — the renderer lays the overlay out into this box, so a zero or negative side has no valid meaning. properties: height: example: 540 exclusiveMinimum: true minimum: 0 type: number width: example: 960 exclusiveMinimum: true minimum: 0 type: number required: - width - height type: object OverlayPointOutput: additionalProperties: false description: >- Top-left corner of the overlay, as a percentage of the video canvas (0-100). Relative so the anchor survives video aspect ratio changes. properties: xPct: example: 30 type: number yPct: example: 30 type: number required: - xPct - yPct type: object TextOverlayTextAlign: description: Horizontal alignment of the text inside its overlay box. enum: - left - center - right example: center type: string responses: 400ErrorResponse: content: application/json: example: error: code: bad_request doc_url: https://tella.tv/docs/api-reference/errors#bad-request message: The request was malformed or contained invalid parameters. schema: $ref: '#/components/schemas/ErrorResponse' description: The request was malformed or contained invalid parameters. 401ErrorResponse: content: application/json: example: error: code: unauthorized doc_url: https://tella.tv/docs/api-reference/errors#unauthorized message: Authentication is required. Provide a valid API key. schema: $ref: '#/components/schemas/ErrorResponse' description: Authentication is required. Provide a valid API key. 403ErrorResponse: content: application/json: example: error: code: forbidden doc_url: https://tella.tv/docs/api-reference/errors#forbidden message: You don't have permission to access this resource. schema: $ref: '#/components/schemas/ErrorResponse' description: You don't have permission to access this resource. 404ErrorResponse: content: application/json: example: error: code: not_found doc_url: https://tella.tv/docs/api-reference/errors#not-found message: The requested resource was not found. schema: $ref: '#/components/schemas/ErrorResponse' description: The requested resource was not found. 422ErrorResponse: content: application/json: example: error: code: unprocessable_entity doc_url: https://tella.tv/docs/api-reference/errors#unprocessable-entity message: The request was well-formed but contained semantic errors. schema: $ref: '#/components/schemas/ErrorResponse' description: The request was well-formed but contained semantic errors. 429ErrorResponse: content: application/json: example: error: code: rate_limit_exceeded doc_url: https://tella.tv/docs/api-reference/errors#rate-limit-exceeded message: You have exceeded the rate limit. Please slow down. schema: $ref: '#/components/schemas/ErrorResponse' description: You have exceeded the rate limit. Please slow down. 500ErrorResponse: content: application/json: example: error: code: internal_server_error doc_url: https://tella.tv/docs/api-reference/errors#internal-server-error message: An unexpected error occurred on the server. schema: $ref: '#/components/schemas/ErrorResponse' description: An unexpected error occurred on the server. securitySchemes: BearerAuth: description: API key obtained from your Tella account settings scheme: bearer type: http ```` ## Related topics - [Model Context Protocol (MCP)](/docs/mcp-server.md) - [Add a text overlay to a clip](/docs/api-reference/clips/add-a-text-overlay-to-a-clip.md) - [List overlays on a clip](/docs/api-reference/clips/list-overlays-on-a-clip.md) - [Update a text overlay](/docs/api-reference/clips/update-a-text-overlay.md) - [Remove a text overlay](/docs/api-reference/clips/remove-a-text-overlay.md)