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

# Update Knowledge Base

`PUT /kb/v1/knowledge-bases/{id}`

Update Knowledge Base

## Path parameters

- `id` string, required

## Request body

- KnowledgeBaseUpdateDTO
  - `title` string — This is the title of the Knowledge Base.
  - `description` string
  - `retrain_frequency_minutes` integer — Automatic retrain interval in minutes. Set retrain_frequency_minutes = 0 to disable automatic retraining. Allowed values: multiples of 60
  - `docs` object[] — Here you can upload URLs
    - `type` 'url'
    - `payload` object — Here you can upload URLs
      - `urls_to_include` KnowledgeBaseUrl[]
        - `url` string, uri — This is the URL of the Knowledge Base.
        - `subpaths_only` boolean — If subpaths_only is enabled, the crawler only processes URLs that are subpaths of the parent URL, ignoring links outside the specified path hierarchy.
        - `recursive` boolean — If recursive is enabled, the crawler recursively scrapes all URLs found on the page, including links to external domains.
      - `urls_to_exclude` KnowledgeBaseUrl[]
        - `url` string, uri — This is the URL of the Knowledge Base.
        - `subpaths_only` boolean — If subpaths_only is enabled, the crawler only processes URLs that are subpaths of the parent URL, ignoring links outside the specified path hierarchy.
        - `recursive` boolean — If recursive is enabled, the crawler recursively scrapes all URLs found on the page, including links to external domains.
  - `files` object[] — List of Files to be associated with the Knowledge Base.
    - `id` string

## Response `200`

Successful response

- KnowledgeBaseDTO
  - `id` string
  - `title` string — This is the title of the Knowledge Base.
  - `description` string
  - `status` 'draft' | 'created' | 'queued' | 'training' | 'trained'
  - `docs` object[] — Here you can upload URLs
    - `type` 'url'
    - `payload` object — Here you can upload URLs
      - `urls_to_include` KnowledgeBaseUrl[]
        - `url` string, uri — This is the URL of the Knowledge Base.
        - `subpaths_only` boolean — If subpaths_only is enabled, the crawler only processes URLs that are subpaths of the parent URL, ignoring links outside the specified path hierarchy.
        - `recursive` boolean — If recursive is enabled, the crawler recursively scrapes all URLs found on the page, including links to external domains.
      - `urls_to_exclude` KnowledgeBaseUrl[]
        - `url` string, uri — This is the URL of the Knowledge Base.
        - `subpaths_only` boolean — If subpaths_only is enabled, the crawler only processes URLs that are subpaths of the parent URL, ignoring links outside the specified path hierarchy.
        - `recursive` boolean — If recursive is enabled, the crawler recursively scrapes all URLs found on the page, including links to external domains.
  - `files` FileResponse[]
    - `id` string
    - `name` string
    - `type` string
    - `createdAt` string, date-time — This is the ISO 8601 date-time string of when the record was created.
    - `updatedAt` string, date-time — This is the ISO 8601 date-time string of when the record was last updated.

## Other responses

- `404` — The provided knowledge base ID does not exist

---

[API](https://skmtc.net/interactly/apis/interactly-api.md) · [All operations](https://skmtc.net/interactly/apis/interactly-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/interactly/interactly-api/versions/f39cdcb1f4e4/schema)