ffmpegapi-net Convert API

The Convert API from ffmpegapi-net — 2 operation(s) for convert.

Operations 2

POST /api/convert_to_vertical Convert a horizontal video to vertical format #
POST /api/convert_video_to_gif Encode a video as an animated GIF #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/ffmpegapi-net:ffmpegapi-net-convert-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ffmpegapi-net-convert-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: FFMPEG Convert 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: Convert
paths:
  /api/convert_to_vertical:
    post:
      operationId: convertToVertical
      tags:
      - Convert
      summary: Convert a horizontal video to vertical format
      description: 'Creates a mobile-oriented vertical output and can apply an optional watermark.


        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/FileOutputResponse'
              examples:
                success:
                  summary: Successful response
                  value:
                    success: true
                    message: Convert to Vertical completed successfully
                    download_url: https://ffmpegapi.net/api/storage/video_abc123.mp4
                    filename: video_abc123.mp4
        '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'
        '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.
                watermark_url:
                  type: string
                  format: uri
                  description: Optional watermark image URL.
                async:
                  type: boolean
                  description: Return a job_id immediately and process in the background.
              additionalProperties: false
            examples:
              default:
                summary: Convert to Vertical request
                value:
                  video_url: https://example.com/landscape.mp4
                  watermark_url: https://example.com/logo.png
  /api/convert_video_to_gif:
    post:
      operationId: convertVideoToGif
      tags:
      - Convert
      summary: Encode a video as an animated GIF
      description: 'Downloads a video and creates a GIF. Optional chroma key transparency supports solid-color backgrounds such as green screen.


        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/FileOutputResponse'
              examples:
                success:
                  summary: Successful response
                  value:
                    success: true
                    message: Convert Video to GIF completed successfully
                    download_url: https://ffmpegapi.net/api/storage/clip_abc123.gif
                    filename: clip_abc123.gif
        '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'
        '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.
                transparent_background:
                  type: boolean
                  default: false
                  description: Apply chroma key transparency.
                chromakey_color:
                  type: string
                  default: '0x00FF00'
                  description: 'Color to key out, such as 0x00FF00 or #00FF00.'
                similarity:
                  type: number
                  minimum: 0.01
                  maximum: 1
                  default: 0.2
                  description: Chroma key similarity from 0.01 to 1.0.
                blend:
                  type: number
                  minimum: 0
                  maximum: 1
                  default: 0.05
                  description: Transparency edge softness from 0.0 to 1.0.
                fps:
                  type: integer
                  minimum: 1
                  maximum: 30
                  default: 10
                  description: Output frame rate from 1 to 30.
                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: Convert Video to GIF request
                value:
                  video_url: https://example.com/clip.mp4
                  transparent_background: true
                  chromakey_color: '0x00FF00'
                  fps: 10
                  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
    FileOutputResponse:
      type: object
      required:
      - success
      - download_url
      properties:
        success:
          type: boolean
          const: true
        message:
          type: string
        download_url:
          type: string
          format: uri
        filename:
          type: string
          examples:
          - video_abc123.mp4
      additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key