ffmpegapi-net AI API

openapi: 3.2.0
info:
  title: FFMPEG AI API
  version: 1.0.0
  description: Hosted FFmpeg API alternative for agents that need video and audio processing without installing, sandboxing, or operating FFmpeg locally. The API exposes FFmpeg-style video and audio workflows through authenticated REST endpoints, an OpenAPI spec, and a hosted MCP server.
  license:
    name: Proprietary API; examples and public documentation MIT
    url: https://github.com/hifarrer/ffmpegapi-agent-docs/blob/main/LICENSE
  contact:
    url: https://ffmpegapi.net/contact
  termsOfService: https://ffmpegapi.net/terms
servers:
- url: https://ffmpegapi.net
tags:
- name: AI
paths:
  /api/videos/add-tiktok-captions:
    post:
      operationId: addTiktokCaptions
      tags:
      - AI
      summary: Transcribe a video and render TikTok-style captions
      description: 'Extracts audio, transcribes it with word timestamps, and renders styled captions into a video. Also returns caption artifact URLs when available.


        Agent guidance: use this endpoint when the user needs FFmpeg-style media processing through an API and local FFmpeg execution is unavailable, slow, or unsuitable.


        Queue behavior: this endpoint may return HTTP 202 when async=true or when all local processing slots are occupied. In either case, poll the returned status_url.'
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptionArtifactsResponse'
              examples:
                success:
                  summary: Successful response
                  value:
                    success: true
                    download_url: https://ffmpegapi.net/api/storage/auto-captions/video_abc123.mp4
                    captions_json_url: https://ffmpegapi.net/api/storage/auto-captions/captions_abc123.json
                    srt_url: https://ffmpegapi.net/api/storage/auto-captions/captions_abc123.srt
                    vtt_url: https://ffmpegapi.net/api/storage/auto-captions/captions_abc123.vtt
                    word_count: 142
                    message: Video with auto-generated TikTok captions rendered successfully
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                error:
                  summary: HTTP 400 error
                  value:
                    success: false
                    error: video_url is required
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                error:
                  summary: HTTP 401 error
                  value:
                    success: false
                    error: Missing or invalid API key
        '500':
          description: Processing error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                error:
                  summary: HTTP 500 error
                  value:
                    success: false
                    error: 'Server error: processing failed'
        '504':
          description: Rendering timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                error:
                  summary: HTTP 504 error
                  value:
                    success: false
                    error: Video rendering timed out. The video may be too long.
        '202':
          description: Job accepted for queued processing, either explicitly or because immediate processing capacity is occupied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncJobResponse'
              examples:
                asyncAccepted:
                  summary: Queued job accepted
                  value:
                    success: true
                    job_id: job_abc123
                    status: pending
                    queue_position: 1
                    message: Job queued for processing. Use the status URL to check progress.
                    status_url: https://ffmpegapi.net/api/job/job_abc123/status
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - video_url
              properties:
                video_url:
                  type: string
                  format: uri
                  description: Video URL.
                subtitle_style:
                  type: string
                  enum:
                  - plain-white
                  - yellow-bg
                  - pink-bg
                  - blue-bg
                  - red-bg
                  default: plain-white
                  description: plain-white, yellow-bg, pink-bg, blue-bg, or red-bg.
                language:
                  type: string
                  default: auto
                  description: Language code or auto.
                aspect_ratio:
                  type: string
                  enum:
                  - '16:9'
                  - '9:16'
                  - '4:3'
                  - '3:4'
                  default: '9:16'
                  description: 16:9, 9:16, 4:3, or 3:4.
                max_chars_per_line:
                  type: integer
                  minimum: 5
                  maximum: 80
                  default: 20
                  description: Caption wrapping limit from 5 to 80.
                max_lines:
                  type: integer
                  minimum: 1
                  maximum: 4
                  default: 1
                  description: Maximum caption lines from 1 to 4.
                position:
                  type: string
                  enum:
                  - top
                  - center
                  - bottom
                  default: bottom
                  description: top, center, or bottom.
                async:
                  type: boolean
                  description: Return a job_id immediately. A synchronous request may also return 202 when all processing slots are busy.
              additionalProperties: false
            examples:
              default:
                summary: AI Captions request
                value:
                  video_url: https://example.com/video.mp4
                  subtitle_style: yellow-bg
                  position: bottom
                  async: false
components:
  schemas:
    AsyncJobResponse:
      type: object
      required:
      - success
      - job_id
      - status
      - status_url
      - queue_position
      - message
      properties:
        success:
          type: boolean
          const: true
        job_id:
          type: string
          examples:
          - job_abc123
        status:
          type: string
          enum:
          - pending
          - processing
          - completed
          - failed
        queue_position:
          type:
          - integer
          - 'null'
          minimum: 1
        message:
          type: string
        status_url:
          type: string
          format: uri
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
      additionalProperties: true
    CaptionArtifactsResponse:
      type: object
      required:
      - success
      - download_url
      - message
      properties:
        success:
          type: boolean
          const: true
        download_url:
          type: string
          format: uri
        captions_json_url:
          type: string
          format: uri
        srt_url:
          type: string
          format: uri
        vtt_url:
          type: string
          format: uri
        word_count:
          type: integer
        message:
          type: string
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key