Documents

Update Document

Update a knowledge base document's name, content, metadata, or folder

patch/agents/documents/{document_id}

Request

Base URL
https://api.cartesia.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/cartesia/apis/cartesia-api/docs/agents/documents/:document_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

document_idstring required

The ID of the document.

Cartesia-Version'2026-03-01' date required

Example:2026-03-01

API version header.

contentstring

New document text. Maximum 1 MB. Updating this property triggers re-indexing of the document.

namestring nullable

New display name. Pass null to clear.

metadataobject

Replacement metadata map. Updating this property triggers re-indexing of the document.

folder_idstring

Move the document to a different folder.

Document updated.

idstring required

The ID of the document.

namestring nullable required

The document's display name, or null if unnamed.

contentstring required

The full document text.

created_atstring date-time required

When the document was uploaded.

metadataobject required

User-defined string-keyed metadata.

No recorded changes to this operation across all 1 revision of this API.