Templates
Templates are created and managed within folders.
Create template
POSThttps://api.openai.com/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 The description of the template to create
type String Spend accounts only
Can be invoice, regular, or grid
Returns
The created template object
curl api.koncile.ai/v1/create_template/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $API_KEY" \
-d '{
"name": string,
"folder_id": int
}'from koncile_sdk.client import KoncileAPIClient
client = KoncileAPIClient(
api_key=API_KEY
)
response = client.templates.create(
folder_id=folder_id,
name=name
)const { Koncile } = require('koncile-js');
require('dotenv').config();
const sdk = new Koncile(process.env.API_KEY);
const response = await sdk.templates.create(folderId, name);
Fetching template
GEThttps://api.openai.com/v1/fetch_template/{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 api.koncile.ai/v1/fetch_template/?template_id=template_id \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $API_KEY"from koncile_sdk.client import KoncileAPIClient
client = KoncileAPIClient(
api_key=API_KEY
)
response = client.templates.get(template_id=template_id)const { Koncile } = require('koncile-js');
require('dotenv').config();
const sdk = new Koncile(process.env.API_KEY);
const response = await sdk.templates.get(templateId);
Update template
PUThttps://api.openai.com/v1/update_template/{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
desc String
type String Spend accounts only
Can be invoice, regular, or grid
Returns
The template object
curl api.koncile.ai/v1/update_template/?template_id=template_id \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $API_KEY"from koncile_sdk.client import KoncileAPIClient
client = KoncileAPIClient(
api_key=API_KEY
)
response = client.templates.update(template_id=template_id)const { Koncile } = require('koncile-js');
require('dotenv').config();
const sdk = new Koncile(process.env.API_KEY);
const response = await sdk.templates.update(templateId);
Delete template
DELETEhttps://api.openai.com/v1/delete_template/{template_id}
Deletes a template, using the template_id
Path parameters
template_id Integer Required The id of the template to update
override Boolean
If True forces deletion. Default False
curl api.koncile.ai/v1/delete_template/?template_id=template_id \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $API_KEY"from koncile_sdk.client import KoncileAPIClient
client = KoncileAPIClient(
api_key=API_KEY
)
response = client.templates.delete(template_id=template_id)const { Koncile } = require('koncile-js');
require('dotenv').config();
const sdk = new Koncile(process.env.API_KEY);
const response = await sdk.templates.delete(templateId);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.
type String Spend accounts only
Can be invoice, regular, or grid
folder_id Integer
The id from the folder the template is linked to
Last updated
Was this helpful?