The OrbConvert API is a RESTful file-conversion service. Upload a file, start a conversion with a target format, poll for completion, and download the result. One endpoint per step, no SDK required.
The API handles file conversion across 10 categories — images, documents, video, audio, archives, vectors, CAD, and ebooks. You can:
https://api.orbconvert.com
All endpoints are prefixed with /api. The API accepts JSON request bodies and returns JSON responses.
Every file conversion follows the same four-step flow:
Authenticate
Send an x-api-key header or Authorization: Bearer token.
Upload a file
POST /api/uploads returns a fileId.
Start a conversion
POST /api/conversions with fileId + toFormat.
Download the result
Poll GET /api/conversions/:id, then download.
The conversion status response includes the conversion ID, current status, progress percentage, and (when complete) the download URL:
{
"conversion": {
"id": "conv_xyz789",
"status": "completed",
"progress": 100,
"outputUrl": "https://api.orbconvert.com/api/files/conv_xyz789/download?token=...",
"outputSize": 102400,
"fromFormat": "docx",
"toFormat": "pdf"
}
}The status field transitions through queued → processing → completed (or failed).
Every API has a dedicated documentation page with endpoints, parameters, examples, and errors:
| API | Category | Status | Docs |
|---|---|---|---|
| File Conversion | Conversion | Available | View docs |
| Office to PDF | Conversion | Available | View docs |
| iWork to PDF | Conversion | Planned | View docs |
| PDF to Office | Conversion | Available | View docs |
| Video Encoding | Conversion | Available | View docs |
| Markdown for LLMs | Conversion | Planned | View docs |
| HTML to PDF | Capture | Planned | View docs |
| Website Screenshot | Capture | Planned | View docs |
| Compress Images | Optimization | Available | View docs |
| Compress PDF | Optimization | Available | View docs |
| Compress Video | Optimization | Available | View docs |
| Merge PDF | Media | Planned | View docs |
| Watermark | Media | Planned | View docs |
| Background Remove | Media | Available | View docs |
| Thumbnail | Media | Planned | View docs |
| Integrations | Workflow | Available | View docs |
Was this page helpful?