---
title: "Update Knowledge Base Route"
method: PUT
path: "/api/knowledge_bases/{knowledge_base_id}"
tags: ["knowledge_base"]
---

# Update Knowledge Base Route

`PUT /api/knowledge_bases/{knowledge_base_id}`

Update a knowledge base.

## Path parameters

- `knowledge_base_id` string, uuid, required

## Request body

- KnowledgeBaseWithConfigUpdate — KnowledgeBase update model with config -- used for updating an existing knowledge_base with config.
  - `ingestion_pipeline_params` KnowledgeBasePipelineParamsInput, required — Knowledge base pipeline params. Parameters defined on the knowledge-base level for a pipeline.
    - `curate` CurateParams, required — Curate params. Defines full curation pipeline, as an ordered dict of named curation steps. Order of steps *does* matter -- they are executed in the order defined.
      - `steps` object
    - `curate_document_store` DocumentStoreParams, required — Document store params.
      - `document_tags` object
    - `transform` TransformParams, required — Transform params. Defines full transform pipeline, as an ordered dict of named transform steps. Order of steps *does* matter -- they are executed in the order defined.
      - `steps` object
    - `vector_store` VectorStoreParams, required — Vector store params.
      - `weaviate_collection_name` string, required — The name of the Weaviate collection to use for storing documents. Must start with AgilityKB and be valid.
      - `node_tags` object
  - `name` string, required
  - `description` string, required

## Response `200`

Successful Response

- KnowledgeBaseWithConfig
  - `ingestion_pipeline_params` KnowledgeBasePipelineParamsOutput, required — Knowledge base pipeline params. Parameters defined on the knowledge-base level for a pipeline.
    - `curate` CurateParams, required — Curate params. Defines full curation pipeline, as an ordered dict of named curation steps. Order of steps *does* matter -- they are executed in the order defined.
      - `steps` object
    - `curate_document_store` DocumentStoreParams, required — Document store params.
      - `document_tags` object
    - `transform` TransformParams, required — Transform params. Defines full transform pipeline, as an ordered dict of named transform steps. Order of steps *does* matter -- they are executed in the order defined.
      - `steps` object
    - `vector_store` VectorStoreParams, required — Vector store params.
      - `weaviate_collection_name` string, required — The name of the Weaviate collection to use for storing documents. Must start with AgilityKB and be valid.
      - `node_tags` object
  - `name` string, required
  - `description` string, required
  - `id` string, uuid, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `deleted_at` string, date-time, nullable, required

## Other responses

- `422` — Validation Error

## Changes

- **2024-12-05** `df1d1cc9e050` — 8 breaking, 8 info
  - removed the enum value `node_summarizer.v0` of the request property `ingestion_pipeline_params/transform/steps/additionalProperties/anyOf[subschema #3: NodeSummarizerV0Params]/name`
  - removed the enum value `noop` of the request property `ingestion_pipeline_params/transform/steps/additionalProperties/anyOf[subschema #4: NoopParams]/name`
  - removed the enum value `postpend_content.v0` of the request property `ingestion_pipeline_params/curate/steps/additionalProperties/oneOf[subschema #3: PostpendContentParams]/name`
  - removed the enum value `remove_embedded_images.v0` of the request property `ingestion_pipeline_params/curate/steps/additionalProperties/oneOf[subschema #4: RemoveEmbeddedImagesParams]/name`
  - …12 more
- **2024-12-03** `c3d745f0888a` — 1 breaking
  - for the `path` request parameter `knowledge_base_id`, the format changed from no format to `uuid`
- …earlier changes not shown

[Full history](https://skmtc.dev/cleanlab/apis/agility/changes/api/knowledge_bases/:knowledge_base_id/put.md)

---

[API](https://skmtc.dev/cleanlab/apis/agility.md) · [All operations](https://skmtc.dev/cleanlab/apis/agility/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cleanlab/agility/revisions/df1d1cc9e050/schema)