Quickstart
Use https://convertz.it as the base URL. The smallest complete integration is one upload request followed by status polling and a download.
curl -X POST "https://convertz.it/api/convert" \
-H "Api-Key: YOUR_API_KEY" \
-F "[email protected]" \
-F "target_format=docx" \
-F "conversion_method=auto"
Authentication
Send the API key generated in your dashboard as a Bearer token. Keep it server-side and never expose it in browser code.
HEADERApi-Key: YOUR_API_KEY
Conversion flow
1 · UploadSend the file and target format.
2 · ReceiveStore the returned job_id.
3 · PollWait until status is completed.
4 · DownloadFetch the result within one hour.
Supported conversions
Each source appears once, followed by every currently supported output format.
For most integrations, conversion_method=auto is the recommended choice.
Endpoints
Convert a file
POST/api/convert
| Field | Required | Description |
|---|
file | Yes | The source document. |
target_format | Yes | Desired output, for example pdf or docx. |
conversion_method | No | Use auto unless a specific engine is required. |
Check status
GET/api/status/{job_id}
Returns queued, processing, completed, or a terminal failure status.
Download result
GET/api/download/{job_id}
Available for one hour after completion. Expired files return HTTP 410.
Health check
GET/api/health
Examples
Queued response
{
"job_id": "eaa81fdc-c790-4aa0-b471-520892688e3a",
"status": "queued"
}
Check status
curl "https://convertz.it/api/status/{job_id}" \
-H "Api-Key: YOUR_API_KEY"
Download
curl -L "https://convertz.it/api/download/{job_id}" \
-H "Api-Key: YOUR_API_KEY" \
-o converted.docx
Errors and integration notes
| Code / situation | Recommended handling |
|---|
401 | Check the API key and Bearer header. |
410 | The download expired; submit a new conversion. |
422 | Validate the file and source-to-target pair. |
429 | Check credits or retry after the rate-limit window. |
| Queued / processing | Poll again after a short delay. |