Endpoints
Job Status
Track the status of your Docswrite publishing jobs
POST
Additional Information
Usage Examples
Polling for Completion
Progress Tracking
You can only check the status of jobs that you created. The API will return a 403 error if you try to check someone else’s job.
Get Job Status
Check the status of a publishing job using the job ID returned when creating a post.
Headers
Header | Value |
---|---|
Content-Type | application/json |
x-access-token | YOUR_JWT_TOKEN |
Request Body
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
jobId | string | Yes | The job ID returned when creating a post |
queueType | string | No | Queue type, defaults to “post” |
Response
Success Response (200 OK)
Job States
State | Description |
---|---|
waiting | Job is in the queue waiting to be processed |
active | Job is currently being processed |
completed | Job finished successfully |
failed | Job failed with an error |
delayed | Job is scheduled to run later |
Response Fields
Field | Type | Description |
---|---|---|
id | string | The job ID |
state | string | Current state of the job |
progress | number | Progress percentage (0-100) |
returnValue | object | Result data when completed |
failedReason | string | Error message if job failed |
timestamp | number | Job creation timestamp |
processedOn | number | When job processing started |
finishedOn | number | When job finished |
cURL Example
Error Responses
Unauthorized (401)
Forbidden (403)
Not Found (404)
Authorizations
JWT token for authenticated requests
Body
application/json
Job status request
The body is of type object
.
Response
200
application/json
Job status retrieved successfully
The response is of type object
.