Skip to content
Gevell Help

Overview

Gevell Convert API 1.0.0

Section titled “Gevell Convert API 1.0.0”

Convert a PDF into a tagged accessible PDF (with its PDF/UA-1 conformance report) and, if you ask for it, accessible HTML, using an API key. Converting is billed per page at the account’s PDF per-page rate; only the estimate is free. The price is reserved when you start, so a start your balance cannot cover is refused with 402 before anything is stored.

Flow: POST /api/v1/convert/estimate (free) -> POST /api/v1/convert -> poll GET /api/v1/convert/{fileId} until done is true -> GET /api/v1/convert/{fileId}/result.

Send an Idempotency-Key header on the start: the same key from the same account is one file, one reservation and one charge, so a client that crashed can resume by repeating the call.

Responses use { "success": true, "data": ... } or { "success": false, "error": { code, message, details } }.

Information

  • OpenAPI version: 3.0.3

Operations

Section titled “ Operations ”
POST
/api/v1/convert/estimate
POST
/api/v1/convert
GET
/api/v1/convert/{fileId}
GET
/api/v1/convert/{fileId}/result
POST
/api/v1/convert/{fileId}/cancel

Authentication

Section titled “ Authentication ”

apiKey

Section titled “apiKey”

A key created in the app under Account > Integrations > API keys.

Security scheme type: apiKey

Header parameter name: X-API-Key