Update Knowledge Base

Update a knowledge base's name, description, or chunking configuration. At least one field must be provided.

PUT/api/v1/knowledge/{id}

Authorization

apiKey
X-API-Key<token>

Your Sim API key (personal or workspace). Generate one from the Sim dashboard under Settings > API Keys.

In: header

Path Parameters

id*string

Knowledge base ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT \  "https://www.sim.ai/api/v1/knowledge/KB_ID" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "YOUR_WORKSPACE_ID",    "name": "Updated Name"  }'
{
  "success": true,
  "data": {
    "knowledgeBase": {
      "id": "kb_abc123",
      "name": "Updated Product Docs",
      "description": "Updated product documentation",
      "docCount": 5,
      "tokenCount": 25000,
      "embeddingModel": "text-embedding-3-small",
      "createdAt": "2026-01-15T10:30:00Z",
      "updatedAt": "2026-01-16T08:00:00Z"
    },
    "message": "Knowledge base updated successfully"
  }
}
{
  "error": "string",
  "details": [
    {}
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
POSTSearch Knowledge BasePOSTUpload Document