Create a Template

curl --request POST \
  --url https://api.pardocs.com/v1/templates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "document_type": "<string>",
  "template_data": {}
}'

import json
import requests

url = "https://api.pardocs.com/v1/templates"
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}
data = {
    "document_type": "<string>",
    "template_data": {}
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.json())

{
  "template_id": "<string>",
  "document_type": "<string>",
  "template_data": {},
  "template_created_at": 123,
  "template_updated_at": 123
}

{
  "detail": "<string>"
}

POST

templates

curl --request POST \
  --url https://api.pardocs.com/v1/templates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "document_type": "<string>",
  "template_data": {}
}'

import json
import requests

url = "https://api.pardocs.com/v1/templates"
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}
data = {
    "document_type": "<string>",
    "template_data": {}
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.json())

{
  "template_id": "<string>",
  "document_type": "<string>",
  "template_data": {},
  "template_created_at": 123,
  "template_updated_at": 123
}

{
  "detail": "<string>"
}

The Create a Template endpoint allows you to define a new template for a specific document type in the ParDocs API. A template specifies the rules and structure for extracting data from documents. By creating a template, you can customize how data is extracted based on your specific needs, which can then be applied to various documents for processing.

Each template has a single {document_type} linked to it.

Note that this process can also be done in the ParDocs Console

Request Body Parameters:

document_type (string): Specifies the document type the schema applies to.
template_data (object): Contains the detailed schema definition for the extraction.

curl --request POST \
  --url https://api.pardocs.com/v1/templates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "document_type": "<string>",
  "template_data": {}
}'

import json
import requests

url = "https://api.pardocs.com/v1/templates"
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}
data = {
    "document_type": "<string>",
    "template_data": {}
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.json())

Authorizations

x-api-key

string

header

required

Body

application/json

document_type

string

The type of the document.

template_data

object

The key-value pairs of information extracted from the document.

Response

Successful Response

template_id

string

document_type

string

The type of the document.

template_data

object

The key-value pairs of information extracted from the document.

template_created_at

integer

template_updated_at

integer

Get Templates Update a Template

Get started

Templates API

Documents API

Create a Template

Authorizations

Body

Response