Skip to main content

Update Workspace

Update workspace settings.

PATCH /v1/workspaces/:id

Path Parameters

ParameterTypeDescription
idstringWorkspace ID

Request Body

FieldTypeDescription
namestringWorkspace name
descriptionstringWorkspace description
settingsobjectWorkspace settings

Example Request

curl -X PATCH https://api.inherent.systems/v1/workspaces/ws_abc123 \
-H "Authorization: Bearer $INHERENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Production Knowledge Base v2",
"settings": {
"default_chunking": "paragraphs"
}
}'

Response

{
"id": "ws_abc123",
"name": "Production Knowledge Base v2",
"description": "Main production documentation and guides",
"settings": {
"default_chunking": "paragraphs",
"embedding_model": "text-embedding-3-small"
},
"updated_at": "2024-01-18T14:20:00Z"
}

Errors

CodeDescription
404Workspace not found
409Workspace name already exists