Skip to main content

Create Workspace

Create a new workspace.

POST /v1/workspaces

Request Body

FieldTypeRequiredDescription
namestringYesWorkspace name
descriptionstringNoWorkspace description
settingsobjectNoWorkspace settings

Example Request

curl -X POST https://api.inherent.systems/v1/workspaces \
-H "Authorization: Bearer $INHERENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Production Knowledge Base",
"description": "Main production documentation and guides",
"settings": {
"default_chunking": "headings",
"embedding_model": "text-embedding-3-small"
}
}'

Response

{
"id": "ws_abc123",
"name": "Production Knowledge Base",
"description": "Main production documentation and guides",
"settings": {
"default_chunking": "headings",
"embedding_model": "text-embedding-3-small"
},
"stats": {
"documents": 0,
"chunks": 0
},
"created_at": "2024-01-15T10:30:00Z"
}

Errors

CodeDescription
400Invalid workspace name
403Workspace limit reached
409Workspace name already exists