Folders

Folders hold the different types of documents and templates.

Create folder

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

Creates a folder

Request body

Name String Required The name of the folder to create

Desc String Optional A detailed description of the folder's purpose or content

Returns

The created folder object

Curl

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

Python

Node

Fetch All Folders

GET https://api.koncile.ai/v1/fetch_all_folders

Returns

The folders object containing an array of folder objects.

Curl

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

Python

NodeJS

Fetching folder

GEThttps://api.koncile.ai/v1/fetch_folder?folder_id={folder_id}

Fetches all information about a folder, using the folder_id

Path parameters

Folder_id Integer Required The id of the folder to fetch

Returns

The folder object

Curl

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

Python

Node

Update folder

PUThttps://api.koncile.ai/v1/update_folder?folder_id={folder_id}

Updates a folder, using the folder_id

Path parameters

Folder_id Integer Required The id of the folder to update

Request body

name String The name of the folder to update

desc String A detailed description of the folder's purpose or content to update

Returns

The folder object

Curl

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

Python

Node

Delete folder

DELETEhttps://api.koncile.ai/v1/delete_folder?folder_id={folder_id}

Deletes a folder, using the folder_id

Path parameters

folder_id Integer Required The id of the folder to delete

override Boolean Optional If True forces deletion. Default False

Curl

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

Python

Node

Folder Object

id Integer

name String The name of the folder

desc String A detailed description of the folder's purpose or content

templates Array List of templates in this folder, each also containing id , name and desc

{
    "id": 1,
    "name": "My Folder",
    "desc": "Description",
    "templates": [
        {"id": 10, "name": "Template 1", "desc": "..."},
        {"id": 11, "name": "Template 2", "desc": "..."}
    ]
}