---
title: "Update Knowledge Base Collection"
method: PATCH
path: "/knowledge-bases/{kbId}"
tags: ["Knowledge Base"]
---

# Update Knowledge Base Collection

`PATCH /knowledge-bases/{kbId}`

## Request

- Base URL: `https://api.speakai.co/v1`
- URL: `https://api.speakai.co/v1/knowledge-bases/{kbId}`
- Auth: API key in header `x-speakai-key` and API key in header `x-access-token`

### Update Collection

Requires the OWNER or ADMIN role. Partial update: send only the fields to change. At least one of name or description is required.

## Path parameters

- `kbId` string, required

## Request body

- object
  - `name` string: Up to 200 characters.
  - `description` string: Up to 1000 characters.

## Response `200`

OK

- object
  - `status` 'success'
  - `data` object
    - `knowledgeBaseId` string: Server-generated. Immutable. The identifier used everywhere for this collection.
    - `name` string: Up to 200 characters.
    - `description` string, nullable: Up to 1000 characters.
    - `documents` object
      - `embeddingStatus` 'pending' | 'processing' | 'completed' | 'failed'
      - `lastIndexedAt` string, date-time, nullable
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/speakai/apis/speak-ai-api.md) · [All operations](https://skmtc.dev/speakai/apis/speak-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/speakai/apis/speak-ai-api/revisions/52d777e6d46e?raw)