---
title: "Update Knowledge Base Document"
method: PATCH
path: "/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}"
tags: ["V1 - Knowledge Bases"]
---

# Update Knowledge Base Document

`PATCH /v1/knowledge-bases/{knowledge_base_id}/document/{document_id}`

## Request

- Base URL: `https://api.app.noxus.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.app.noxus.ai/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}`
- Auth: API key in header `X-API-Key`

## Path parameters

- `knowledge_base_id` string, required
- `document_id` string, required

## Request body

- UpdateDocument
  - `name` string, nullable
  - `summary` string, nullable
  - `short_summary` string, nullable
  - `status` 'trained' | 'training' | 'error' | 'uploaded' | 'folder' | 'outdated'
  - `doc_type` string, nullable
  - `error` object, nullable
  - `warnings` SpotWarning[], nullable
    - `detail` string, required
    - `identifier` 'general' | 'model_fallback' | 'model_timeout' | 'reading_spreadsheet' | 'invalid_search' | 'no_results_returned' | 'integration_warning' | 'failed_scraping' | 'invalid_value' | 'continue_on_error' | 'data_ingestion' | 'document_already_exists' | 'ingestion_timeout' | 'libreoffice_conversion' | 'low_confidence' | 'guardrail_validation' | 'kb_creation' | 'kb_empty' | 'unsupported_qa_file_type' | 'unsupported_file_type' | 'no_files_to_add_to_kb' | 'no_files_added_to_kb' | 'no_google_drive_files' | 'no_one_drive_files' | 'no_sharepoint_files' | 'no_websites_scraped' | 'websites_failed_scraping' | 'empty_file' | 'document_overwrite' | 'no_content_provided' | 'invalid_folder' | 'document_name_too_long' | 'retry_warning' | 'tabular_truncated' | 'results_truncated' | 'nested_list_flattened' | 'iteration_failures' | 'password_protected' | 'malformed_document' | 'unreadable_encoding', required
    - `node_id` string, nullable
    - `params` object
    - `markdown` string, nullable
    - `snippet` string, nullable
  - `prefix` string, nullable
  - `file_id` string, uuid, nullable
  - `dismissed` boolean, nullable
  - `needs_reingestion` boolean, nullable
  - `doc_metadata` object, nullable

## Response `200`

Successful Response

- KnowledgeBaseDocument
  - `id` string, uuid, required
  - `summary` string, nullable, required
  - `short_summary` string, nullable
  - `doc_type` string, nullable
  - `source_type` string, nullable
  - `source_external_id` string, nullable
  - `source_metadata` object, nullable
  - `content_type` string, nullable
  - `has_conversion` boolean, nullable
  - `status` 'trained' | 'training' | 'error' | 'uploaded' | 'folder' | 'outdated', required
  - `doc_metadata` object, nullable
  - `error` object, nullable, required
  - `name` string, nullable
  - `prefix` string, nullable
  - `uri` string, nullable
  - `updated_at` string, date-time, required
  - `created_at` string, date-time, required
  - `size` integer, required
  - `file_id` string, uuid, nullable
  - `run_id` string, uuid, nullable
  - `dismissed` boolean, nullable
  - `warnings` unknown[], nullable
    - unknown
  - `needs_reingestion` boolean, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/noxus/apis/noxus-backend.md) - [All operations](https://skmtc.dev/noxus/apis/noxus-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/noxus/apis/noxus-backend/revisions/0e37810b7ad5?raw)