Knowledge base

Collections and items your AI answers from.

GET/knowledge/collectionsList knowledge collections
POST/knowledge/collectionsCreate a knowledge collection
GET/knowledge/collections/{cid}Get a knowledge collection
PATCH/knowledge/collections/{cid}Update a knowledge collection
DELETE/knowledge/collections/{cid}Delete a knowledge collection
GET/knowledge/itemsList knowledge items
POST/knowledge/itemsCreate a knowledge item
GET/knowledge/items/{id}Get a knowledge item
PATCH/knowledge/items/{id}Update a knowledge item
DELETE/knowledge/items/{id}Delete a knowledge item
POST/knowledge/items/{id}/restoreRestore an item from the trash
POST/knowledge/items/{id}/starStar an item
DELETE/knowledge/items/{id}/starRemove an item's star
POST/knowledge/items/bulkMove, trash, restore or permanently delete several items at once
POST/knowledge/items/nativeCreate a new document or spreadsheet
POST/knowledge/items/{id}/duplicateMake a copy of a file
GET/knowledge/items/{id}/exportDownload a file as xlsx, csv, docx, json, txt or the original upload
GET/knowledge/items/{id}/versionsList a file's saved versions
POST/knowledge/items/{id}/versionsSave a named version of a file
POST/knowledge/items/{id}/versions/{vid}/restoreRestore a file to an earlier version
GET/knowledge/share-subjectsFind people, teams and roles a file can be shared with
GET/knowledge/items/{id}/sharesList who a file is shared with
POST/knowledge/items/{id}/sharesShare a file with a person, team or role
DELETE/knowledge/items/{id}/sharesStop sharing a file with someone
PUT/knowledge/items/{id}/org-accessSet what everyone in the workspace can do with a file
PUT/knowledge/items/{id}/inheritChoose whether a file follows its folder's permissions
POST/knowledge/items/{id}/ownerTransfer ownership of a file
GET/knowledge/collections/{cid}/sharesList who a folder is shared with
POST/knowledge/collections/{cid}/sharesShare a folder — everything inside it follows
DELETE/knowledge/collections/{cid}/sharesStop sharing a folder with someone
PUT/knowledge/collections/{cid}/org-accessSet what everyone in the workspace can do with a folder
POST/knowledge/items/{id}/mentionsTell the people mentioned in a comment
GET/knowledge/templatesList document and spreadsheet templates
POST/knowledge/items/{id}/templateSave a copy of a file as a reusable template
GET/knowledge/items/{id}/linksList a file's share links
POST/knowledge/items/{id}/linksCreate a share link for a file
DELETE/knowledge/items/{id}/links/{linkId}Turn off a share link
POST/knowledge/items/uploadUpload a file to the knowledge base

List knowledge collections

GET/knowledge/collections

Scope knowledge_base:viewRead-only

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/knowledge/collections" \  -H "Authorization: Bearer $KLERC_TOKEN"

Create a knowledge collection

POST/knowledge/collections

Scope knowledge_base:createWrites data

Request body

Field	Type
`name`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/collections" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"name":"…"}'

Get a knowledge collection

GET/knowledge/collections/{cid}

Scope knowledge_base:viewRead-only

Path parameters

Name	Type
`cid`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/knowledge/collections/{cid}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Update a knowledge collection

PATCH/knowledge/collections/{cid}

Scope knowledge_base:manageWrites data

Path parameters

Name	Type
`cid`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X PATCH "https://api.klerc.co/api/v1/knowledge/collections/{cid}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Delete a knowledge collection

DELETE/knowledge/collections/{cid}

Scope knowledge_base:manageWrites data

Path parameters

Name	Type
`cid`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X DELETE "https://api.klerc.co/api/v1/knowledge/collections/{cid}" \  -H "Authorization: Bearer $KLERC_TOKEN"

List knowledge items

GET/knowledge/items

Scope knowledge_base:viewRead-only

Query parameters

Name	Type
`limit`	number
`cursor`	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/knowledge/items?limit=25" \  -H "Authorization: Bearer $KLERC_TOKEN"

Create a knowledge item

POST/knowledge/items

Scope knowledge_base:createWrites data

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items" \  -H "Authorization: Bearer $KLERC_TOKEN"

Get a knowledge item

GET/knowledge/items/{id}

Scope knowledge_base:viewRead-only

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/knowledge/items/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Update a knowledge item

PATCH/knowledge/items/{id}

Scope knowledge_base:manageWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X PATCH "https://api.klerc.co/api/v1/knowledge/items/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Delete a knowledge item

DELETE/knowledge/items/{id}

Scope knowledge_base:manageWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X DELETE "https://api.klerc.co/api/v1/knowledge/items/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Restore an item from the trash

POST/knowledge/items/{id}/restore

Scope knowledge_base:manageWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/{id}/restore" \  -H "Authorization: Bearer $KLERC_TOKEN"

Star an item

POST/knowledge/items/{id}/star

Scope knowledge_base:viewWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/{id}/star" \  -H "Authorization: Bearer $KLERC_TOKEN"

Remove an item's star

DELETE/knowledge/items/{id}/star

Scope knowledge_base:viewWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X DELETE "https://api.klerc.co/api/v1/knowledge/items/{id}/star" \  -H "Authorization: Bearer $KLERC_TOKEN"

Move, trash, restore or permanently delete several items at once

POST/knowledge/items/bulk

Scope knowledge_base:manageWrites data

Request body

Field	Type
`op`required	"move" \| "trash" \| "restore" \| "purge"
`ids`required	array of string
`collectionId`	string \| null

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/bulk" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"op":"move","ids":["…"],"collectionId":"…"}'

Create a new document or spreadsheet

POST/knowledge/items/native

Scope knowledge_base:createWrites data

Request body

Field	Type
`kind`required	"sheet" \| "doc"
`name`	string
`description`	string
`collectionId`	string \| null

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/native" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"kind":"sheet","name":"…","description":"…","collectionId":"…"}'

Make a copy of a file

POST/knowledge/items/{id}/duplicate

Scope knowledge_base:createWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`name`	string
`collectionId`	string \| null

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/{id}/duplicate" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"name":"…","collectionId":"…"}'

Download a file as xlsx, csv, docx, json, txt or the original upload

GET/knowledge/items/{id}/export

Scope knowledge_base:exportRead-only

Path parameters

Name	Type
`id`required	string

Query parameters

Name	Type
`format`	"xlsx" \| "csv" \| "docx" \| "json" \| "txt" \| "md" \| "original"

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/knowledge/items/{id}/export" \  -H "Authorization: Bearer $KLERC_TOKEN"

List a file's saved versions

GET/knowledge/items/{id}/versions

Scope knowledge_base:viewRead-only

Path parameters

Name	Type
`id`required	string

Query parameters

Name	Type
`limit`	number
`before`	number

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/knowledge/items/{id}/versions?limit=25" \  -H "Authorization: Bearer $KLERC_TOKEN"

Save a named version of a file

POST/knowledge/items/{id}/versions

Scope knowledge_base:manageWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`label`	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/{id}/versions" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"label":"…"}'

Restore a file to an earlier version

POST/knowledge/items/{id}/versions/{vid}/restore

Scope knowledge_base:manageWrites data

Path parameters

Name	Type
`id`required	string
`vid`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/{id}/versions/{vid}/restore" \  -H "Authorization: Bearer $KLERC_TOKEN"

Find people, teams and roles a file can be shared with

GET/knowledge/share-subjects

Call this first to turn a name like "the sales team" into the subjectId that knowledge.shares.set needs.

Scope knowledge_base:shareRead-only

Query parameters

Name	Type
`q`	string
`type`	"user" \| "team" \| "role"

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/knowledge/share-subjects" \  -H "Authorization: Bearer $KLERC_TOKEN"

List who a file is shared with

GET/knowledge/items/{id}/shares

Scope knowledge_base:viewRead-only

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/knowledge/items/{id}/shares" \  -H "Authorization: Bearer $KLERC_TOKEN"

Share a file with a person, team or role

POST/knowledge/items/{id}/shares

Resolve the subjectId with knowledge.shares.subjects first. Only a file's owner can change who has access.

Scope knowledge_base:shareWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`subjectType`required	"user" \| "team" \| "role"
`subjectId`required	string
`role`required	"viewer" \| "commenter" \| "editor"
`notify`	boolean
`message`	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/{id}/shares" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"subjectType":"user","subjectId":"…","role":"viewer","notify":false,"message":"…"}'

Stop sharing a file with someone

DELETE/knowledge/items/{id}/shares

Scope knowledge_base:shareWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`subjectType`required	"user" \| "team" \| "role"
`subjectId`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X DELETE "https://api.klerc.co/api/v1/knowledge/items/{id}/shares" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"subjectType":"user","subjectId":"…"}'

Set what everyone in the workspace can do with a file

PUT/knowledge/items/{id}/org-access

Scope knowledge_base:shareWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`orgAccess`required	"none" \| "viewer" \| "commenter" \| "editor"

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X PUT "https://api.klerc.co/api/v1/knowledge/items/{id}/org-access" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"orgAccess":"none"}'

Choose whether a file follows its folder's permissions

PUT/knowledge/items/{id}/inherit

Scope knowledge_base:shareWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`inherit`required	boolean

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X PUT "https://api.klerc.co/api/v1/knowledge/items/{id}/inherit" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"inherit":false}'

Transfer ownership of a file

POST/knowledge/items/{id}/owner

Scope knowledge_base:shareWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`userId`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/{id}/owner" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"userId":"…"}'

List who a folder is shared with

GET/knowledge/collections/{cid}/shares

Scope knowledge_base:viewRead-only

Path parameters

Name	Type
`cid`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/knowledge/collections/{cid}/shares" \  -H "Authorization: Bearer $KLERC_TOKEN"

Share a folder — everything inside it follows

POST/knowledge/collections/{cid}/shares

Scope knowledge_base:shareWrites data

Path parameters

Name	Type
`cid`required	string

Request body

Field	Type
`subjectType`required	"user" \| "team" \| "role"
`subjectId`required	string
`role`required	"viewer" \| "commenter" \| "editor"
`notify`	boolean

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/collections/{cid}/shares" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"subjectType":"user","subjectId":"…","role":"viewer","notify":false}'

Stop sharing a folder with someone

DELETE/knowledge/collections/{cid}/shares

Scope knowledge_base:shareWrites data

Path parameters

Name	Type
`cid`required	string

Request body

Field	Type
`subjectType`required	"user" \| "team" \| "role"
`subjectId`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X DELETE "https://api.klerc.co/api/v1/knowledge/collections/{cid}/shares" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"subjectType":"user","subjectId":"…"}'

Set what everyone in the workspace can do with a folder

PUT/knowledge/collections/{cid}/org-access

Scope knowledge_base:shareWrites data

Path parameters

Name	Type
`cid`required	string

Request body

Field	Type
`orgAccess`required	"none" \| "viewer" \| "commenter" \| "editor"

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X PUT "https://api.klerc.co/api/v1/knowledge/collections/{cid}/org-access" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"orgAccess":"none"}'

Tell the people mentioned in a comment

POST/knowledge/items/{id}/mentions

Scope knowledge_base:viewWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`commentId`	number
`userIds`required	array of string
`text`	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/{id}/mentions" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"commentId":0,"userIds":["…"],"text":"…"}'

List document and spreadsheet templates

GET/knowledge/templates

Scope knowledge_base:viewRead-only

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/knowledge/templates" \  -H "Authorization: Bearer $KLERC_TOKEN"

Save a copy of a file as a reusable template

POST/knowledge/items/{id}/template

Scope knowledge_base:createWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`name`	string
`category`	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/{id}/template" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"name":"…","category":"…"}'

List a file's share links

GET/knowledge/items/{id}/links

Scope knowledge_base:viewRead-only

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/knowledge/items/{id}/links" \  -H "Authorization: Bearer $KLERC_TOKEN"

Create a share link for a file

POST/knowledge/items/{id}/links

The link's secret is returned once and never again. audience "public" works without an account and is capped at commenter.

Scope knowledge_base:shareWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`access`	"viewer" \| "commenter" \| "editor"
`audience`	"org" \| "public"
`password`	string
`expiresAt`	string
`maxViews`	number
`allowDownload`	boolean

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/{id}/links" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"access":"viewer","audience":"org","password":"…","expiresAt":"…","maxViews":0,"allowDownload":false}'

Turn off a share link

DELETE/knowledge/items/{id}/links/{linkId}

Scope knowledge_base:shareWrites data

Path parameters

Name	Type
`id`required	string
`linkId`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X DELETE "https://api.klerc.co/api/v1/knowledge/items/{id}/links/{linkId}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Upload a file to the knowledge base

POST/knowledge/items/upload

Scope knowledge_base:createWrites data

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/knowledge/items/upload" \  -H "Authorization: Bearer $KLERC_TOKEN"