Skip to main content
PATCH
Update Document

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

documentation_id
string
required

The id of a document from the knowledge base. This is returned on document addition.

Example:

"21m00Tcm4TlvDq8ikWAM"

Body

application/json
name
string | null

A custom, human-readable name for the document.

Minimum string length: 1
content
string | null

Updated content for the document. Only supported for text documents, URL documents with auto-sync disabled, and file documents.

Response

Successful Response

id
string
required
name
string
required
metadata
KnowledgeBaseDocumentMetadataResponseModel · object
required
supported_usages
enum<string>[]
required
Available options:
prompt,
auto
access_info
ResourceAccessInfo · object
required
Example:
type
string
required
Allowed value: "url"
url
string
required
extracted_inner_html
string
required
folder_parent_id
string | null

The ID of the parent folder, or null if the document is at the root level.

folder_path
KnowledgeBaseFolderPathSegmentResponseModel · object[]

The folder path segments leading to this entity, from root to parent folder.

content_format
enum<string>
default:html

Canonical representation of a knowledge base document's stored content.

HTML is the legacy default; documents created before this field existed are interpreted as HTML.

Available options:
html,
markdown
auto_sync_info
AutoSyncInfo · object | null