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.
openapi: 3.2.0
info:
title: Convert Online Downloads 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 Downloads 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: Downloads
description: Collecting the converted file
paths:
/v1/download/{token}:
parameters:
- name: token
in: path
required: true
description: The token from a finished export task's URL
schema:
type: string
get:
tags:
- Downloads
summary: Download a converted file
description: The URL a finished `export/url` task hands back. The token is the whole credential, so the link works on its own.
operationId: downloadResult
security: []
responses:
'200':
description: The converted file
content:
application/octet-stream:
schema:
type: string
format: binary
'404':
$ref: '#/components/responses/NotFound'
servers:
- url: https://api.convert.online
description: Production
components:
responses:
NotFound:
description: No such job, import or file
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
properties:
status:
type: string
example: error
message:
type: string
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