PDpdf
Document, File & System

Background & Job Check

Changed on

Checks the status of a background job that was previously created with PDF.co API. Use this API to check the status of your asynchronous API calls.

post/v1/job/check

Request

  • Base URL
    https://api.pdf.co
  • URL
    https://api.pdf.co/v1/job/check
  • Auth
    API key in header x-api-key

Request body

jobidstring required

Id of processing that was started asynchronously

timeoutnumber

Timeout for output links in seconds

Response

Success.

statusstring

Status of the API response.

messagestring

Descriptive message for the response status.

urlstring uri

URL to the output file.

jobIdstring

Unique identifier for the job.

creditsinteger

Credits used for this operation.

remainingCreditsinteger

Credits remaining after this operation.

durationinteger

Time taken to complete the request, in milliseconds.

Example response

{
  "status": "success",
  "message": "Success",
  "url": "https://pdf-temp-files.s3.us-west-2.amazonaws.com/output.pdf",
  "jobId": "6YSZD3U872ZYYFEDMQCQSGEEO8YSF5WA",
  "credits": 2,
  "remainingCredits": 1480582,
  "duration": 33
}

Changes