Skip to main content

​
GET /v1/pdf/documentparser/templates/:id

Use the PDF.co dashbaord to manage your Document Parser Templates.
Please refer to the Document Parser Template Editor and PDF.co Document Parser: Template Creation Guide for more information.

​
Query parameters

No query parameters accepted.

​
Responses

ParameterTypeDescription
idintegerUnique identifier for the template
typestringSource of the template. The available sources are: user, system.
titlestringTitle of the template
descriptionstringDescription of what the template does
created_atString (ISO 8601)Timestamp indicating when the template was initially created
updated_atString (ISO 8601)Timestamp indicating the last time the template was modified
bodystringTemplate content
creditsintegerNumber of credits consumed by the request
remainingCreditsintegerNumber of credits remaining in the account
Inconsistent URL Encoding in cURL Output: When using cURL to make API requests, the output JSON may show URL characters encoded as Unicode escape sequences. For example, the ampersand character (&) may appear as \u0026 in the cURL output. This is normal JSON encoding behavior and does not affect the validity of the URL. The URL will function correctly when used, as JSON parsers automatically decode these escape sequences. If you’re parsing the response programmatically, your JSON parser will handle this conversion automatically.

​
Code Samples

  • CURL
  • JavaScript/Node.js
  • Python
  • C#
  • Java
  • PHP
curl --location --request GET 'https://api.pdf.co/v1/pdf/documentparser/templates/1' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {{x-api-key}}' \
--data-raw ''