---
title: "Update Knowledge Base"
method: PUT
path: "/api/v1/knowledge/{id}"
tags: ["Knowledge Bases"]
---

# Update Knowledge Base

`PUT /api/v1/knowledge/{id}`

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

## Path parameters

- `id` string, required

## Request body

- object
  - `workspaceId` string, required — The workspace the knowledge base belongs to.
  - `name` string — New name (1-255 characters).
  - `description` string — New description (max 1000 characters).
  - `chunkingConfig` ChunkingConfig — Configuration for how documents are split into chunks for embedding.
    - `maxSize` integer — Maximum chunk size in tokens.
    - `minSize` integer — Minimum chunk size in characters.
    - `overlap` integer — Overlap between chunks in tokens.

## Response `200`

Knowledge base updated successfully.

- object
  - `success` boolean — Whether the request was successful.
  - `data` object — Response payload containing the updated knowledge base.
    - `knowledgeBase` KnowledgeBase — A knowledge base for storing and searching document embeddings.
      - `id` string — Unique knowledge base identifier.
      - `name` string — Knowledge base name.
      - `description` string, nullable — Optional description.
      - `tokenCount` integer — Total token count across all documents.
      - `embeddingModel` string — Embedding model used (e.g. text-embedding-3-small).
      - `embeddingDimension` integer — Embedding vector dimension.
      - `chunkingConfig` ChunkingConfig — Configuration for how documents are split into chunks for embedding.
        - `maxSize` integer — Maximum chunk size in tokens.
        - `minSize` integer — Minimum chunk size in characters.
        - `overlap` integer — Overlap between chunks in tokens.
      - `docCount` integer — Number of documents in the knowledge base.
      - `connectorTypes` string[] — Types of connectors attached to this knowledge base.
      - `createdAt` string, date-time — ISO 8601 timestamp when the knowledge base was created.
      - `updatedAt` string, date-time — ISO 8601 timestamp when the knowledge base was last modified.
    - `message` string — Human-readable confirmation message.

## Other responses

- `400` — Invalid request parameters. Check the details array for specific validation errors.
- `401` — Invalid or missing API key. Ensure the X-API-Key header is set with a valid key.
- `403` — Access denied. You do not have permission to access this resource. For audit log endpoints, this requires an Enterprise subscription and organization admin/owner role.
- `404` — The requested resource was not found. Verify the ID is correct and belongs to your workspace.
- `429` — Rate limit exceeded. Wait for the duration specified in the Retry-After header before retrying. The X-RateLimit-* headers accompany every response from an authenticated v1 request — success and error alike — and are omitted only when the request fails authentication, since no rate-limit bucket is consulted in that case.

---

[API](https://skmtc.dev/simstudioai/apis/sim-api.md) · [All operations](https://skmtc.dev/simstudioai/apis/sim-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/simstudioai/sim-api/revisions/66a471c5b1df/schema)