Skip to main content

​
GET /v1/pdf/documentparser/templates

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
templatesarray[object]
remainingCreditsintegerNumber of credits remaining in the account
creditsintegerNumber of credits consumed by the request

​
Example Response

To see the main response codes, please refer to the Response Codes page.
{
  "templates": [
    {
      "id": 40,
      "type": "user",
      "title": "Untitled",
      "description": "Untitled"
    },
    {
      "id": 1,
      "type": "system",
      "title": "Invoice Parser",
      "description": "Parses invoices and extracts invoice number, company name, due date, amount, tax"
    }
  ],
  "remainingCredits": 94229
}
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
curl --location --request GET 'https://api.pdf.co/v1/pdf/documentparser/templates' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {{x-api-key}}'