Templates

Templates are created and managed within folders.

Create template

POSThttps://api.koncile.ai/v1/create_template

Creates a template

Path parameters

template_id Integer Optional Logic for copying another template, using their template_id

Request body

folder_id Integer Required The id of the folder inside which the template is created

name String Required The name of the template to create, unique

desc String Optional The description of the template to create

number_locale String Optional Locale for number formatting. Can be EU (European format: "123 456,78") or US (US format: "123,456.78")

date_locale String Optional Locale for date formatting. Can be EU (European format: DD/MM/YYYY) or US (US format: MM/DD/YYYY)

Returns

The template object

Curl

curl api.koncile.ai/v1/create_template/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
  "name": string,
  "folder_id": int
}'

Python

Node

Fetching template

GEThttps://api.koncile.ai/v1/fetch_template?template_id={template_id}

Fetches all informations about a template, using the template_id

Path parameters

template_id Integer Required The id of the template to fetch

Returns

The template object

Curl

curl api.koncile.ai/v1/fetch_template/?template_id=template_id \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

Python

Node

Update template

PUThttps://api.koncile.ai/v1/update_template?template_id={template_id}

Updates a template, using the template_id

Path parameters

template_id Integer Required The id of the template to update

Request body

name String Optional The name of the template to update

desc String Optional The description of the template to update

number_locale String Optional Locale for number formatting. Can be EU (European format: "123 456,78") or US (US format: "123,456.78")

date_locale String Optional Locale for date formatting. Can be EU (European format: DD/MM/YYYY) or US (US format: MM/DD/YYYY)

Returns

The template object

Curl

curl api.koncile.ai/v1/update_template/?template_id=template_id \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

Python

Node

Delete template

DELETEhttps://api.koncile.ai/v1/delete_template?template_id={template_id}

Deletes a template, using the template_id

Path parameters

template_id Integer Required The id of the template to update

override Boolean Optional If True forces deletion of documents inside this template. Default False

Curl

curl api.koncile.ai/v1/delete_template/?template_id=template_id \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

Python

Node

Template Object

id Integer

name String The name of the template

desc String A more detailled description of the template. Informations can have an impact on the document output.

folder_id Integer The id from the folder the template is linked to

field_ids Array[Integer] List of field IDs belonging to this template

instruction_ids Array[Integer] List of instruction IDs belonging to this template

{
    "id": 10,
    "name": "My Template",
    "desc": "Template description",
    "folder_id": 1,
    "field_ids": [100, 101, 102],
    "instruction_ids": [200, 201]
}