API Reference
Poll Status
Check the status of document conversion tasks
Poll Status
Check the progress and status of a document conversion task.
Endpoint
GET /v1/status/poll/{task_id}Authentication
All requests require authentication using the X-Api-Key header with your API key.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
task_id | string | Yes | The task ID returned from a conversion request |
Request Headers
| Header | Required | Description |
|---|---|---|
X-Api-Key | Yes | Your API key for authentication |
Response
Success Response (200 OK)
Returns the current status of the conversion task:
{
"task_id": "abc123def456",
"task_type": "convert",
"task_status": "success",
"task_position": null,
"task_meta": null,
"error_message": null
}| Field | Type | Description |
|---|---|---|
task_id | string | The unique identifier for this task |
task_type | string | Always "convert" for conversion tasks |
task_status | string | Current status (see Status Values) |
task_position | integer | Position in queue (null when processing or complete) |
task_meta | object | Additional metadata (currently unused) |
error_message | string | Error description if status is "failure", otherwise null |
Status Values
| Status | Description | Next Action |
|---|---|---|
pending | Task is queued and waiting to be processed | Continue polling |
processing | Conversion is currently in progress | Continue polling |
success | Conversion completed successfully | Retrieve results using /v1/result/{task_id} |
failure | Conversion failed with an error | Check error_message field for details |
Error Responses
To be added.
Examples
Find examples of using the Status endpoint in the Examples section.
Polling Best Practices
To be added.
Next Steps
Once the status is "success":
- Retrieve results - Use the
/v1/result/{task_id}endpoint to get the converted document - Process the output - Parse and use the converted content in your application
Common Issues
To be added.
Related Endpoints
- Convert Source - Convert documents from URLs
- Convert File - Upload and convert local files
- Get Results - Retrieve converted documents