Reference

API Documentation

Security Simplified

Authentication

We use a dual-authentication layer: a Bearer Token for identity and a Static Signature for verification.

Required Headers

Authorization
Bearer YOUR_API_KEY
X-Signature
STATIC_HMAC_SIGNATURE

Copy this directly from your Profile settings.

Signature Calculation (Optional)

If you wish to calculate it yourself, it is an HMAC-SHA256 hash of your API Key using your Sign Key as the secret.

hash_hmac('sha256', $apiKey, $signKey);
GET /api/conversions

List History

Retrieve your conversion history. Results are paginated and sorted by the most recent first.

Query Parameters

page Integer • Default: 1

The page number for paginated results.

POST /api/conversions

Create Conversion

Send a document to our queue for processing. We handle the heavy lifting while you wait for the results.

Form Parameters

Key Description
mode Required • String

word_to_pdf, pdf_to_word, or excel_to_pdf

document Required • File

The file to convert (Max 50MB).

excel_page_orientation Required for Excel - String

portrait or landscape.

excel_page_mode Required for Excel - String

auto or one_sheet_one_page.

excel_paper_size Optional for Excel - String

letter or a4. Default: letter.

excel_margin_* Optional for Excel - Number

excel_margin_left, right, top, bottom in inches. Default: 0.709, 0.709, 0.4, 0.45.

GET /api/conversions/{uuid}

Fetch Status

Check if your conversion is done. Completed jobs return a temporary download URL.

Pro Tip: Previews

The download_url can accept an optional inline=1 query parameter to view the document directly in the browser (useful for PDF output).

Response Lifecycle

Queue

PENDING

Engine

PROCESSING

Ready

COMPLETED

Error

FAILED

POST /api/conversions/{uuid}/cancel

Cancel Job

Immediately terminate a queued or processing job. Jobs that are already completed or failed cannot be cancelled.