> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ringbee.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Overlay Text

> Overlay text on video

<RequestExample>
  ```json Example Request theme={null}
  {
    "input": "https://example.com/video.mp4",
    "text": "Hello World",
    "x": 10,
    "y": 10,
    "fontsize": 24
  }
  ```

  ```bash File Upload theme={null}
  curl -X POST https://api.ringbee.dev/v1/video/overlay-text \
    -H "X-API-Key: YOUR_API_KEY" \
    -F "file=@video.mp4" \
    -F "text=Hello World" \
    -F "x=10" \
    -F "y=10" \
    -F "fontsize=24"
  ```
</RequestExample>

| Param    | Type    | Description                   |
| -------- | ------- | ----------------------------- |
| text     | string  | Text to overlay on the video  |
| x        | integer | Horizontal position in pixels |
| y        | integer | Vertical position in pixels   |
| fontsize | integer | Font size in points           |


## OpenAPI

````yaml POST /v1/video/overlay-text
openapi: 3.0.3
info:
  title: MediAPI
  description: >-
    Media processing API — video, audio, image, and document transformations via
    simple REST calls.
  version: 1.0.0
servers:
  - url: https://api.ringbee.dev
    description: Production
security:
  - apiKey: []
paths:
  /v1/video/overlay-text:
    post:
      tags:
        - Video
      summary: Overlay Text
      description: Overlay text on video
      operationId: videoOverlayText
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - input
              properties:
                input:
                  type: string
                  description: Input file URL
                text:
                  type: string
                  description: Text to overlay on the video
                x:
                  type: integer
                  description: Horizontal position in pixels
                'y':
                  type: integer
                  description: Vertical position in pixels
                fontsize:
                  type: integer
                  description: Font size in points
                webhook_url:
                  type: string
                  description: URL to receive job completion notification
          multipart/form-data:
            schema:
              type: object
              required:
                - file
              properties:
                file:
                  type: string
                  format: binary
                  description: Upload file directly
                text:
                  type: string
                  description: Text to overlay on the video
                x:
                  type: integer
                  description: Horizontal position in pixels
                'y':
                  type: integer
                  description: Vertical position in pixels
                fontsize:
                  type: integer
                  description: Font size in points
                webhook_url:
                  type: string
                  description: URL to receive job completion notification
      responses:
        '202':
          description: Job accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Usage limit reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    JobResponse:
      type: object
      properties:
        id:
          type: string
          example: job_abc123
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
            - cancelled
          example: pending
    Error:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key

````