Fields
Fields to be extracted
Create field
POSThttps://api.openai.com/v1/create_field
Creates a field to extract
Request body
template_id Integer Required The id of the folder inside which the field is created
name String Required The name of the field to create, unique
type String Require
Defines whether the field is extracted once (General fields) or for every line (Line fields)
desc String The description of the field to create
format String The kind of field to extract, with their custom formatting. By default "text". For all the field formats, please refer to this page.
position Integer The field position in the output, relative to the other fields. Default: appended to the end
Returns
The created field object
curl api.koncile.ai/v1/create_field/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $API_KEY" \
-d '{
"template_id": integer,
"name": "string",
"type": "string"
}'from koncile_sdk.client import KoncileAPIClient
client = KoncileAPIClient(
api_key=API_KEY
)
response = client.fields.create(
template_id=template_id,
name=name,
type=type
)const { Koncile } = require('koncile-js');
require('dotenv').config();
const sdk = new Koncile(process.env.API_KEY);
const response = await sdk.fields.create(templateId, name, type);Fetching field
GEThttps://api.openai.com/v1/fetch_field/{field_id}
Fetches all the informations about a field, using the field_id
Path parameters
field_id Integer Required The id of the field to fetch
Returns
The field object
curl api.koncile.ai/v1/fetch_field/?field_id=field_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.fields.get(field_id=field_id)const { Koncile } = require('koncile-js');
require('dotenv').config();
const sdk = new Koncile(process.env.API_KEY);
const response = await sdk.fields.get(fieldId);
Update field
PUThttps://api.openai.com/v1/update_field/{field_id}
Updates a field, using the field
Path parameters
field_id Integer Required The id of the field to update
Request body
name String The name of the field to create, unique
desc String The description of the field to create
format String The kind of field to extract, with their custom formatting. By default "text". For all the field formats, please refer to this page.
type String
Defines whether the field is extracted once (General fields) or for every line (Line fields)
position Integer The field position in the output, relative to the other fields. Default: appended to the end
Returns
The field object
curl api.koncile.ai/v1/update_field/?field_id=field_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.fields.update(field_id=field_id)const { Koncile } = require('koncile-js');
require('dotenv').config();
const sdk = new Koncile(process.env.API_KEY);
const response = await sdk.fields.update(fieldId);Delete field
DELETEhttps://api.openai.com/v1/delete_field/{field_id}
Deletes a field, using the field_id
Path parameters
field_id Integer Required The id of the field to update
curl api.koncile.ai/v1/delete_field/?field_id=field_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.fields.delete(field_id=field_id)const { Koncile } = require('koncile-js');
require('dotenv').config();
const sdk = new Koncile(process.env.API_KEY);
const response = await sdk.fields.delete(fieldId);
Field Object
id Integer
name String
The name of the field, unique
desc String
The description of the field
format String
The kind of field to extract, with their custom formatting. By default "text".
For all the field formats, please refer to this page.
type String
Defines whether the field is extracted once (General fields) or for every line (Line fields)
position Integer
The field position in the output, relative to the other fields. Default: appended to the end
Template_id Integer
The id from the template the field is linked to
Last updated
Was this helpful?