Folders

Folders hold the different types of documents and templates.

Create folder

POSThttps://api.openai.com/v1/create_folder

Creates a folder

Request body

Name String Required The name of the folder to create

Desc String 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

from koncile_sdk.client import KoncileAPIClient


client = KoncileAPIClient(
    api_key=API_KEY
)

response = client.folders.create(
    name=name,
    desc=desc
)

Fetching folder

GEThttps://api.openai.com/v1/fetch_folder/{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

from koncile_sdk.client import KoncileAPIClient


client = KoncileAPIClient(
    api_key=API_KEY
)

response = client.folders.get(folder_id=folder_id)

Update folder

PUThttps://api.openai.com/v1/update_folder/{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

from koncile_sdk.client import KoncileAPIClient


client = KoncileAPIClient(
    api_key=API_KEY
)

response = client.folders.update(folder_id=folder_id)

Delete folder

DELETEhttps://api.openai.com/v1/delete_folder/{folder_id}

Deletes a folder, using the folder_id

Path parameters

folder_id Integer Required The id of the folder to delete

override Boolean 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

from koncile_sdk.client import KoncileAPIClient


client = KoncileAPIClient(
    api_key=API_KEY
)

response = client.folders.delete(folder_id=folder_id)

Folder Object

id Integer

name String The name of the folder

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