ConverterHQDevelopers
Documentation

Quickstart

Make your first ConverterHQ API conversion in minutes.

ConverterHQ is simple for one-file conversions and scales into a full task workflow when you need it. You do not need to learn Jobs, Tasks or cloud connections before your first request.

Your first conversion

From request to result
Your appFile or URL
ConverterHQ APIValidate + accept
Durable JobConversion Tasks
Output FileSigned download
A short request can complete during the wait window; longer work keeps running behind the same durable Job handle.
from converterhq import ConverterHQ

# Reads CONVERTERHQ_API_KEY. hq_test_* keys automatically use the sandbox.
client = ConverterHQ()
result = client.convert(
    "report.docx",
    from_format="docx",
    to="pdf",
    wait=20,
)
result.save("report.pdf")

Use a hq_test_... key while integrating. Test credentials are isolated from live resources and do not consume production credits.

When work becomes asynchronous

The same request may return 200 when it completes during your bounded wait window or 202 with a durable Job when processing continues. Add Prefer: respond-async when you never want to wait.

What to learn next

For larger files use Files and direct signed uploads. For production automation use Jobs plus signed webhooks.