Background Jobs Check
Checks status of background job that was previously created with PDF.co API.
Available Methods
[POST] /job/check
jobId
required. Id of background that was started asynchronously. Must be a String. To start a new async background job, you should setasync
totrue
for API methods.force
optional. Set totrue
to forcely check the status of the background job. Intended to be used with really long and heavy background jobs only.
Returns JSON with status of the background job.
Available status values:
working
background job is currently in work or does not exist.success
background job was successfully finished.failed
background job failed for some reason (seemessage
for more details).aborted
background job was aborted.unknown
unknown background job id. Available only whenforce
is set totrue
for input request.- Method: POST
- URL: /v1/job/check
Query parameters
No query parameters accepted.
Body payload
{
"jobid": "12345"
}
Example responses
/job/check
{
"status": "working",
"remainingCredits": 60227
}
Code Snippet
CURL
curl --location --request POST 'https://api.pdf.co/v1/job/check' \
--header 'x-api-key: ' \
--data-raw '{
"jobid": "12345"
}'
Samples
- C# - Check Job Status
- Java - Check Job Status
- JavaScript - Check Job Status
- PHP - Check Job Status
- PowerShell - Check Job Status
- Python - Check Job Status
- cURL - Check Job Status
Copyright © 2016 - 2023 PDF.co