Skip to content
API v1 · Stable contract

BUILT FOR YOUR NEXT BUILD

File conversion. Part of your product.

Bring conversion into your application with the same v1 contract used by our SDKs and developer tools. Start in the sandbox, then move the same workflow to production.

From a file to a finished task

Provide a file

A consistent approach to document, image and media conversion.

Choose the conversion

Clear inputs, conversion settings and results, from request to output.

Use the result

Executable examples and the API reference are available in the developer documentation.

PDF → DOCXDirect upload · pair settings · async jobs · output download
# Contract-backed API v1 example. Pair-specific settings are validated by the capability schema.
# Local bytes always bypass the API process: create an owned File, upload to its signed URL, then submit the File ID.
API="https://sandbox.api.converterhq.io/v1"
FILE_JSON=$(curl -fsS "$API/files"   -H "Authorization: Bearer $CONVERTERHQ_API_KEY"   -H "Content-Type: application/json"   -d '{"filename":"input.pdf","content_type":"application/octet-stream","retention_seconds":3600}')
FILE_ID=$(printf '%s' "$FILE_JSON" | python3 -c 'import json,sys; print(json.load(sys.stdin)["id"])')
UPLOAD_URL=$(printf '%s' "$FILE_JSON" | python3 -c 'import json,sys; print(json.load(sys.stdin)["upload"]["url"])')
curl -fsS -X PUT "$UPLOAD_URL" --upload-file "input.pdf"
curl -fsS -X POST "$API/files/$FILE_ID/complete"   -H "Authorization: Bearer $CONVERTERHQ_API_KEY"   -H "Content-Type: application/json" -d '{}'

curl -fsS "$API/jobs"   -H "Authorization: Bearer $CONVERTERHQ_API_KEY"   -H "Content-Type: application/json"   -H "Idempotency-Key: example-pdf-docx-001"   -d '{"tasks":{"convert":{"operation":"convert","input":{"file_id":"'"$FILE_ID"'"},"options":{"input_format":"pdf","output_format":"docx","settings":{}}}}}'

# Official SDK convert helpers perform the same Files → signed storage → Jobs transport.

Contract-backed API v1 example. Pair-specific settings are validated by the capability schema.

Help shape what comes next

Tell us about your formats, volume and integration needs. We’d like to hear what you are building.