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

# Add text overlay

> Add a text overlay to a video. The video is processed with FFmpeg and a public URL for the result is returned.



## OpenAPI

````yaml /openapi.json post /videos/overlay
openapi: 3.0.0
info:
  title: RawUGC API
  version: 1.0.0
  description: >-
    Generate AI videos, images, and music, and schedule social media posts
    programmatically.
  contact:
    name: API Support
    email: support@rawugc.com
    url: https://docs.rawugc.com
  license:
    name: Proprietary
servers:
  - url: https://rawugc.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Tasks
    description: >-
      Deprecated. Use typed resource endpoints instead: GET /videos/{videoId},
      GET /images/{imageId}, GET /music/{musicId}.
  - name: Image Generation
    description: >-
      Generate and edit AI images using Nano Banana models. Supports
      text-to-image generation (6 credits) and image-to-image editing (2
      credits).
  - name: Video Generation
    description: Generate and manage AI videos using Sora 2, Kling, and Veo 3 models
  - name: Personas
    description: Manage target audience personas for content plans
  - name: Messaging
    description: Manage brand/positioning messaging for content plans
  - name: Products
    description: Manage products for video generation
  - name: Styles
    description: Manage video creative styles and templates
  - name: Characters
    description: List available AI characters for video generation
  - name: Video Editing
    description: Post-process videos with captions, overlays, and effects
  - name: Upload
    description: Upload video and image files for use in generation requests
  - name: Social Scheduling
    description: Schedule and manage social media posts to TikTok, Instagram, and YouTube
  - name: Social Accounts
    description: Manage connected social media accounts
  - name: Music Generation
    description: >-
      Generate AI music tracks using Suno models with customizable genre, mood,
      and style
  - name: Viral Library
    description: >-
      Browse and search analyzed TikTok videos across the platform. Includes
      AI-powered analysis with hooks, keyframes, performance insights, and
      semantic search via natural language queries.
  - name: Research
    description: >-
      Scrape TikTok videos, analyze any video, and generate content plans. Tools
      for competitive research and content strategy.
paths:
  /videos/overlay:
    post:
      tags:
        - Video Editing
      summary: Add text overlay
      description: >-
        Add a text overlay to a video. The video is processed with FFmpeg and a
        public URL for the result is returned.
      operationId: addOverlay
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VideoOverlayRequest'
            example:
              videoId: vid_jh7a3b9xq2pn4r8k
              text: Check this out!
              position: bottom
              fontSize: 48
      responses:
        '200':
          description: Overlay added successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoOverlayResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    VideoOverlayRequest:
      type: object
      required:
        - videoId
        - text
      properties:
        videoId:
          type: string
          description: Video identifier (vid_xxx format)
        text:
          type: string
          minLength: 1
          maxLength: 500
          description: Text to overlay on the video
        fontSize:
          type: integer
          minimum: 8
          maximum: 200
          description: 'Font size in pixels (default: auto)'
        position:
          type: string
          enum:
            - top
            - center
            - bottom
          description: Vertical position of the text overlay
        topBottomMargin:
          type: integer
          minimum: 0
          maximum: 500
          description: Margin from top/bottom edge in pixels
        strokeThickness:
          type: number
          minimum: 0
          maximum: 10
          description: Text stroke/outline thickness
    VideoOverlayResponse:
      $ref: '#/components/schemas/EditResponse'
    ApiError:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: >-
            URI reference identifying the problem type (e.g.,
            https://api.rawugc.com/errors/validation_error)
        title:
          type: string
          description: Short, human-readable summary of the problem
        status:
          type: number
          description: HTTP status code
        detail:
          type: string
          description: Human-readable explanation of the problem
        instance:
          type: string
          format: uri
          description: URI reference identifying this specific occurrence
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Field-specific validation errors
    EditResponse:
      type: object
      description: Response from a video editing operation (captions, overlay)
      properties:
        videoId:
          type: string
          description: Unique identifier for the new version (vid_xxx format)
        url:
          type: string
          format: uri
          description: URL to download the edited video
        version:
          type: integer
          description: Version number of the edit (2 for first edit, etc.)
        operation:
          type: string
          description: Operation that was performed (e.g. 'caption', 'overlay')
        creditsUsed:
          type: number
          description: Credits deducted for this operation
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Use your API key from the RawUGC dashboard. Include as: Authorization:
        Bearer YOUR_API_KEY

````