curl --request GET \
--url https://api.docsautomator.co/job/{jobId} \
--header 'Authorization: Bearer <token>'{
"jobId": "<string>",
"progress": 50,
"createdAt": "2023-11-07T05:31:56Z",
"processedOn": "2023-11-07T05:31:56Z",
"finishedOn": "2023-11-07T05:31:56Z",
"result": {
"message": "success",
"pdfUrl": "<string>",
"documentName": "<string>",
"googleDocUrl": "<string>",
"savePdfGoogleDriveUrl": "<string>",
"savePdfGoogleDriveFileId": "<string>",
"signingSessionId": "<string>",
"signingLinks": [
{
"signerIndex": 123,
"email": "<string>",
"name": "<string>",
"signingUrl": "<string>",
"status": "<string>"
}
]
},
"error": "<string>",
"attempts": 123
}Get job status
Check the status of an async document creation job. Poll this endpoint after receiving a jobId from POST /createDocument with async: true.
Progress values: 10% (queued) → 20% (fetching data) → 30% (processing template) → 40% (generating PDF) → 100% (complete).
curl --request GET \
--url https://api.docsautomator.co/job/{jobId} \
--header 'Authorization: Bearer <token>'{
"jobId": "<string>",
"progress": 50,
"createdAt": "2023-11-07T05:31:56Z",
"processedOn": "2023-11-07T05:31:56Z",
"finishedOn": "2023-11-07T05:31:56Z",
"result": {
"message": "success",
"pdfUrl": "<string>",
"documentName": "<string>",
"googleDocUrl": "<string>",
"savePdfGoogleDriveUrl": "<string>",
"savePdfGoogleDriveFileId": "<string>",
"signingSessionId": "<string>",
"signingLinks": [
{
"signerIndex": 123,
"email": "<string>",
"name": "<string>",
"signingUrl": "<string>",
"status": "<string>"
}
]
},
"error": "<string>",
"attempts": 123
}Authorizations
API key from your workspace settings. Pass as Authorization: Bearer <key> or X-API-Key: <key>. Find it at app.docsautomator.co/settings/workspace/api.
Path Parameters
The job ID returned from async document creation.
Response
Job status retrieved
Current job status.
waiting, active, completed, failed Progress percentage (10 → 20 → 30 → 40 → 100).
0 <= x <= 100When processing started.
When processing finished.
The document creation result (only present when status is completed).
Show child attributes
Show child attributes
Error message (only present when status is failed).
Number of processing attempts.