Skip to main content
POST
/
template
Create Template
curl --request POST \
  --url https://{base_url}/template \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form 'name=<string>' \
  --form 'description=<string>' \
  --form 'schema=<string>' \
  --form 'custom_id=<string>' \
  --form 'instruction=<string>' \
  --form 'config=<string>' \
  --form 'metadata=<string>'
{
  "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

Body

multipart/form-data

Request for creating a new template.

Content-Type: multipart/form-data

Important: Complex objects (schema, config, metadata) must be sent as JSON-stringified values in form fields.

​
name
string
required

Template name

​
description
string
required

Template description

​
schema
string
required

JSON-stringified schema defining extraction fields. Example - '{"field1":"string","field2":"number"}'

​
custom_id
string

Custom identifier (1-100 chars, alphanumeric + underscore/hyphen, starts with letter or underscore)

Pattern: ^[a-zA-Z_][a-zA-Z0-9_-]{0,99}$
​
instruction
string

Additional processing instructions

​
config
string

JSON-stringified TemplateConfig object

​
metadata
string

JSON-stringified metadata object for custom data storage

Response

Template created successfully

​
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