ffmpegapi-net Jobs API

openapi: 3.2.0
info:
  title: FFMPEG Jobs 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: Jobs
paths:
  /api/job/{job_id}/status:
    get:
      operationId: getJobStatus
      tags:
      - Jobs
      summary: Check queued media job status
      description: 'Returns pending, processing, completed, or failed status for an explicitly asynchronous or automatically queued media job. Pending jobs include queue_position; timestamps and attempt_count are returned 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.'
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatusResponse'
              examples:
                success:
                  summary: Successful response
                  value:
                    success: true
                    job_id: job_abc123
                    job_type: merge_videos
                    status: completed
                    created_at: '2026-06-11T14:05:00Z'
                    updated_at: '2026-06-11T14:07:18Z'
                    started_at: '2026-06-11T14:05:02Z'
                    finished_at: '2026-06-11T14:07:18Z'
                    attempt_count: 1
                    download_url: https://ffmpegapi.net/api/storage/merged_abc123.mp4
                    result_url: https://ffmpegapi.net/api/storage/merged_abc123.mp4
                    filename: merged_abc123.mp4
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                error:
                  summary: HTTP 400 error
                  value:
                    success: false
                    error: request 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'
        '403':
          description: Job belongs to another API key owner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                error:
                  summary: HTTP 403 error
                  value:
                    success: false
                    error: Access denied
        '404':
          description: Job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                error:
                  summary: HTTP 404 error
                  value:
                    success: false
                    error: Job not found
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
        description: Async job ID.
components:
  schemas:
    ErrorResponse:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
      additionalProperties: true
    JobStatusResponse:
      type: object
      required:
      - success
      - job_id
      - job_type
      - status
      - created_at
      - updated_at
      properties:
        success:
          type: boolean
          const: true
        job_id:
          type: string
        job_type:
          type: string
        status:
          type: string
          enum:
          - pending
          - processing
          - completed
          - failed
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        started_at:
          type:
          - string
          - 'null'
          format: date-time
        finished_at:
          type:
          - string
          - 'null'
          format: date-time
        attempt_count:
          type: integer
          minimum: 0
        queue_position:
          type: integer
          minimum: 1
        download_url:
          type: string
          format: uri
        result_url:
          type: string
          format: uri
        filename:
          type: string
          examples:
          - video_abc123.mp4
        error:
          type: string
      additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key