Convert.Online Jobs API

Create, start and follow conversion jobs

GitHub OpenAPI

Operations 4

POST /v1/process/jobs Create a conversion job #
GET /v1/process/jobs/{jobId} Get a job #
POST /v1/process/jobs/{jobId}/complete-upload Start the conversion once the bytes have arrived #
GET /v1/process/jobs/{jobId}/events Follow a job as it runs (Server-Sent Events) #

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/convert-online:convert-online-jobs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

convert-online-jobs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Convert Online Jobs API
  version: 1.0.0
  contact:
    name: Convert.Online support
    url: https://convert.online/contact
    email: support@convert.online
  license:
    name: Proprietary
    url: https://convert.online/terms
  termsOfService: https://convert.online/terms
  description: 'Operations tagged Jobs across 2 of this provider''s published API definitions: convert-online-openapi.json, convert-online-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.convert.online
  description: Production
security:
- bearerAuth: []
- apiKeyHeader: []
tags:
- name: Jobs
  description: Create, start and follow conversion jobs
paths:
  /v1/process/jobs:
    post:
      tags:
      - Jobs
      summary: Create a conversion job
      description: 'Creates a job from a map of named tasks. A task''s `input` names the task it takes its source from, which is how several steps chain into one job.


        When the source is an upload, the response carries where to send the bytes and the job waits at `waiting_upload` until you call `complete-upload`.'
      operationId: createJob
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobRequest'
            examples:
              convertAnUpload:
                summary: Upload a HEIC photo and get a JPG
                value:
                  tasks:
                    import-1:
                      operation: import/upload
                    convert-1:
                      operation: convert
                      input: import-1
                      input_format: heic
                      output_format: jpg
                    export-1:
                      operation: export/url
                      input:
                      - convert-1
              convertFromUrl:
                summary: Convert a file that is already online
                value:
                  tasks:
                    import-1:
                      operation: import/url
                      url: https://example.com/report.docx
                    convert-1:
                      operation: convert
                      input: import-1
                      output_format: pdf
                    export-1:
                      operation: export/url
                      input:
                      - convert-1
              sandbox:
                summary: Validate the shape without converting anything
                value:
                  sandbox: true
                  tasks:
                    import-1:
                      operation: import/url
                      url: https://example.com/a.png
                    convert-1:
                      operation: convert
                      input: import-1
                      output_format: jpg
                    export-1:
                      operation: export/url
                      input:
                      - convert-1
      responses:
        '201':
          description: Job created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          description: Not enough conversion quota left on the plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The job did not validate — an unknown operation, a broken chain, or more conversions than the plan runs at once
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: The job store is unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.convert.online
      description: Production
  /v1/process/jobs/{jobId}:
    parameters:
    - $ref: '#/components/parameters/JobId'
    get:
      tags:
      - Jobs
      summary: Get a job
      description: Poll until `status` is `finished` or `failed`. The finished job's export task carries the download URL.
      operationId: getJob
      responses:
        '200':
          description: The job as it stands
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '503':
          description: The job store is unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.convert.online
      description: Production
  /v1/process/jobs/{jobId}/complete-upload:
    parameters:
    - $ref: '#/components/parameters/JobId'
    post:
      tags:
      - Jobs
      summary: Start the conversion once the bytes have arrived
      description: Call this after sending the file. Until it is called the job stays at `waiting_upload` and nothing is converted.
      operationId: completeUpload
      responses:
        '200':
          description: The job is queued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://api.convert.online
      description: Production
  /v1/process/jobs/{jobId}/events:
    parameters:
    - $ref: '#/components/parameters/JobId'
    get:
      tags:
      - Jobs
      summary: Follow a job as it runs (Server-Sent Events)
      description: An `text/event-stream` of the job's progress, so a client can react the moment the conversion ends instead of polling.
      operationId: streamJobEvents
      responses:
        '200':
          description: An event stream; each event carries the job in the same shape as GET /v1/process/jobs/{jobId}
          content:
            text/event-stream:
              schema:
                type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://api.convert.online
      description: Production
components:
  schemas:
    CreateJobRequest:
      type: object
      required:
      - tasks
      properties:
        tasks:
          type: object
          description: Named tasks. The key is the name you refer to in another task's `input`.
          additionalProperties:
            $ref: '#/components/schemas/Task'
        tag:
          type: string
          maxLength: 255
          description: Your own label, echoed back on the job.
        sandbox:
          type: boolean
          description: Validate and return a simulated finished job. Nothing converts, no quota is spent, no key is required.
        import_id:
          type: string
          description: Build the job around a file already sent to an import, instead of an `import/*` task.
          pattern: ^[a-f0-9]{32}$
    Error:
      type: object
      properties:
        status:
          type: string
          example: error
        message:
          type: string
    TaskStatus:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        job:
          type: string
        operation:
          type: string
        status:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Job:
      type: object
      properties:
        id:
          type: string
          pattern: ^[a-f0-9]{32}$
        tag:
          type: string
        status:
          type: string
          description: '`waiting_upload` until the bytes arrive and `complete-upload` is called; then it queues, runs, and ends `finished` or `failed`.'
          enum:
          - waiting_upload
          - waiting
          - queued
          - processing
          - converting
          - finished
          - failed
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        startedAt:
          type:
          - string
          - 'null'
          format: date-time
        endedAt:
          type:
          - string
          - 'null'
          format: date-time
        tasks:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TaskStatus'
        result:
          type:
          - object
          - 'null'
          description: Present once the job has finished.
          additionalProperties: true
        error:
          type: string
          description: Why the job failed; empty otherwise.
        links:
          type: object
          properties:
            self:
              type: string
    Task:
      type: object
      required:
      - operation
      properties:
        operation:
          type: string
          description: What this step does.
          enum:
          - import/upload
          - import/url
          - import/base64
          - import/s3
          - import/sftp
          - import/googlecloud
          - convert
          - export/url
          - export/s3
          - export/sftp
          - export/googlecloud
          - export/webhook
        input:
          description: The task this one takes its source from. `convert` names one; an export takes a list.
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        url:
          type: string
          format: uri
          description: 'For `import/url`: where to fetch the source from.'
        input_format:
          type: string
          description: Source format. Optional — inferred from the file name or URL when it can be.
        output_format:
          type: string
          description: 'For `convert`: the target format, e.g. `jpg`, `pdf`, `mp3`.'
        options:
          type: object
          description: Conversion settings — resizing, quality, codecs and so on. The names differ per conversion; see the documentation for the pair you are converting.
          additionalProperties: true
  parameters:
    JobId:
      name: jobId
      in: path
      required: true
      description: The job's id
      schema:
        type: string
        pattern: ^[a-f0-9]{32}$
  responses:
    Unauthorized:
      description: The key is missing, wrong, or restricted to other IPs
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: No such job, import or file
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'An API key from Dashboard → API Keys, sent as `Authorization: Bearer <key>`.'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: The same key, sent in its own header instead.
externalDocs:
  description: Full API documentation
  url: https://convert.online/api-docs
x-refined-from:
- convert-online-openapi.json
- convert-online-openapi.yml