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 Imports 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 Imports 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: Imports
description: Getting a local file to the server
paths:
/v1/imports:
post:
tags:
- Imports
summary: Create an import to receive a local file
description: Returns somewhere to put the bytes. Use it for any file that is not already reachable at a URL.
operationId: createImport
responses:
'200':
description: Where to send the file
content:
application/json:
schema:
$ref: '#/components/schemas/Import'
'401':
$ref: '#/components/responses/Unauthorized'
'503':
description: The import store is unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://api.convert.online
description: Production
/v1/imports/{importId}/content:
parameters:
- name: importId
in: path
required: true
description: The import's id
schema:
type: string
pattern: ^[a-f0-9]{32}$
- name: token
in: query
required: false
description: One-use upload token, as returned with the import. It stands in for the API key, so no key need appear in an upload command.
schema:
type: string
put:
tags:
- Imports
summary: Send the file's bytes
description: The body is the raw file, streamed — not a form upload. `POST` is accepted as well as `PUT`.
operationId: uploadImportContent
requestBody:
required: true
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
'200':
description: The file arrived
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'413':
description: The file is larger than the import ceiling
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
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'
Unauthorized:
description: The key is missing, wrong, or restricted to other IPs
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
properties:
status:
type: string
example: error
message:
type: string
Import:
type: object
properties:
id:
type: string
pattern: ^[a-f0-9]{32}$
upload:
type: object
description: The ways to deliver the bytes. The signed storage URL is the direct route; the proxy accepts the same file through this API, for a network that cannot reach storage.
additionalProperties: true
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