Retrieve Template by ID (API Tester)

Run Retrieve Template by ID live from your browser — send a real request and see the response and credit usage, no code required. PDF.co API Tester.

GET /v1/pdf/documentparser/templates/{id}

Retrieve Template by ID

cURL

curl --request GET \
  --url https://api.pdf.co/v1/pdf/documentparser/templates/{id} \
  --header 'x-api-key: <api-key>'

200

{
  "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
}

Full reference: Retrieve Template by ID → API Reference — all parameters, response fields, and limits.

Authorizations

x-api-key · string · header · required

Path Parameters

id · string · required

Document parser template id

Response

200

application/json

Success.

status · string

Status of the API response.

Example:

"success"

message · string

Descriptive message for the response status.

Example:

"Success"

url · string<uri>

URL to the output file.

Example:

"https://pdf-temp-files.s3.us-west-2.amazonaws.com/output.pdf"

jobId · string

Unique identifier for the job.

Example:

"6YSZD3U872ZYYFEDMQCQSGEEO8YSF5WA"

credits · integer

Credits used for this operation.

Example:

2

remainingCredits · integer

Credits remaining after this operation.

Example:

1480582

duration · integer

Time taken to complete the request, in milliseconds.

Example:

33