Skip to main content
GET
/
template
/
{template_id}
Get Template
curl --request GET \
  --url https://{base_url}/template/{template_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "ee0e0e3f-7f71-4f70-859c-2e1e9f44f1e3",
  "name": "<string>",
  "description": "<string>",
  "custom_id": "<string>",
  "instruction": "<string>",
  "schema": {},
  "config": {
    "use_parser": true,
    "parser_mode": "LITE",
    "extraction_mode": "NEXUS",
    "preset_mode": "FAST",
    "use_chunk": false,
    "chunking_config": {
      "strategy": "PAGE",
      "target_chunk_size": 1
    },
    "enable_citations": false
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

template_id
string<uuid>
required

Template UUID

Response

Template details

id
string<uuid>

Unique template identifier

Example:

"ee0e0e3f-7f71-4f70-859c-2e1e9f44f1e3"

name
string

Template name

description
string

Template description

custom_id
string | null

Custom identifier

instruction
string | null

Additional processing instructions

schema
object

JSON schema configuration defining extraction fields

config
object

Template configuration for processing behavior

metadata
object

Custom metadata object for additional data storage

created_at
string<date-time>

Template creation timestamp

updated_at
string<date-time> | null

Last update timestamp