Skip to main content
PATCH
Update Document

Authorizations

Authorization
string
header
default:$CARTESIA_API_KEY
required

Cartesia API key (sk_car_...). Get one at play.cartesia.ai/keys.

Headers

Cartesia-Version
enum<string>
default:2026-03-01
required

API version header.

Available options:
2026-03-01
Example:

"2026-03-01"

Path Parameters

document_id
string
required

The ID of the document.

Body

application/json

Fields to update on a document

content
string

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

Minimum string length: 1
name
string | null

New display name. Pass null to clear.

metadata
object

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

folder_id
string

Move the document to a different folder.

Response

Document updated.

id
string
required

The ID of the document.

name
string | null
required

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

content
string
required

The full document text.

created_at
string<date-time>
required

When the document was uploaded.

metadata
object
required

User-defined string-keyed metadata.