See Stacksync in action with a solution architect. Book a demo ↗
Knowledge bases

Knowledge bases

Update a knowledge base

PATCH
/v1/workspaces/{workspace_id}/knowledge-bases/{knowledge_base_id}

Renames a knowledge base or changes whether every member of the workspace may use it. With validate_only, the checks run and 204 answers, nothing changes.

Authorization

Authorizationstringheaderrequired

Bearer <key>, where <key> is a workspace API key or a user API key. See Authentication.

Path Parameters

workspace_id*integer

The workspace. List the ones your key can reach with GET /v1/workspaces.

knowledge_base_id*string

The knowledge base.

Formatuuid

Query Parameters

region*Regions

Region of the resource: besg (Europe) or usnv (United States), as GET /v1/regions lists them

Value in"besg""usnv"

Request Body

application/json
  1. body
name?|

New name

Defaultnull
is_shared_with_workspace?|

true lets every member of the workspace use it

Defaultnull
validate_only?Validate Only

Run every check of the write and answer 204 without writing: a refused write answers the error the write would

Defaultfalse

Response Body

OK

application/json
  1. response

A knowledge base, which genies answer from

knowledge_base_id*Knowledge Base Id
name*Name
resource_id*Resource Id
region*Region
is_shared_with_workspace*Is Shared With Workspace
folder_id*string|null
created_time*Created Time
Formatdate-time
last_modified_time*Last Modified Time
Formatdate-time
Update a knowledge base
curl -X PATCH 'https://api.stacksync.com/v1/workspaces/0/knowledge-bases/497f6eca-6276-4993-bfeb-53cbbbba6f08?region=besg' \  -H 'Content-Type: application/json' \  -d '{  "name": "<name>"}'
{  "knowledge_base_id": "<knowledge_base_id>",  "name": "<name>",  "resource_id": "<resource_id>",  "region": "<region>",  "is_shared_with_workspace": false,  "folder_id": "<folder_id>",  "created_time": "2027-01-15T09:00:00Z",  "last_modified_time": "2027-01-15T09:00:00Z"}