Skip to main content
cURL
Try it live: Background & Job Check → API Tester lets you send a real request from your browser.

POST /v1/job/check

Quick start

Use the jobId returned by another endpoint with async: true, or by an asynchronous-only endpoint. Job Check applies only to asynchronous calls.
This request only needs the job ID in the jobid field.
Send jobId as lowercase jobid and use the same PDF.co account API key in the x-api-key header.

Request body

Attributes are case-sensitive and should be inside JSON for POST request. for example: { "jobid": "YOUR_JOB_ID" } No query parameters accepted.
string
required
ID returned by another endpoint called with async set to true, or by an asynchronous-only endpoint.

Responses

Available Status Values

The HTTP status code and job status describe different outcomes. HTTP 200 means the check succeeded. The response body’s status field reports whether the job is working, success, failed, or aborted.
Jobs are private to the account that created them. This endpoint checks jobs belonging to the account identified by your API key. If a known job ID returns HTTP 404, first check that you are using the same API key that created it. See Job not found.

Completed job example

The illustrative 200 example shows a job in progress. This response shows the same job after it produced a file. Both examples show legacy billing, which charges 2 credits per check for these job states. The output format depends on the original request.
In cURL output, JSON may represent an ampersand in a URL as \u0026. A JSON parser decodes it to & when you read the URL.
The response examples are illustrative. Error fields vary by failure. The request limit shown in the 429 example is illustrative and depends on your account. For HTTP errors, status: "error" describes the request error.

Response fields

The fields returned depend on the job, its state, and the result available when you check it.
string
Current job state. See Available Status Values.
string
Details about the job state or the reason a request failed.
integer
Page count when the original operation reports one.
string
Download URL when the job returns a file.
Expiration timestamp when the job reports one for its output link.
string
ID of the background job being checked, when returned.
integer
Credits charged for this status check. With legacy billing, checking a working or success job costs 2 credits. With newer billing, these checks cost 0 credits. Checking a failed job costs 0 credits. Use the returned credits value to see the charge for each check.
integer
Account credit balance reported with this response.
integer
Execution time of the original background job in milliseconds, when available.
integer
Reported processing time for the status check in milliseconds.

Job not found (HTTP 404)

See Response Codes for more information about HTTP errors.
If you omit jobid, the API returns HTTP 404 with a message beginning Missing parameter jobid. Add the ID from the original request and send the corrected body. If you supply a jobid and receive Job not found, verify the ID and API key before checking again. The ID may be incorrect, belong to another account, or refer to a job that is no longer available.