Skip to main content
PATCH
Update a document

Authorizations

Authorization
string
header
required

A Custral secret API key (sk_…), created in Settings → Applications. Sent as Authorization: Bearer sk_…. The X-Api-Key: sk_… header is also accepted and takes precedence. Never expose a secret key in a browser.

Path Parameters

id
string
required

The document id (doc_…).

Body

application/json

The body of an update-document request. The document id is in the path.

content
string
required

The new document body, as markdown. Replaces the document's content in full.

Example:

"## Notes\n\nUpdated by the integration."

Response

The updated document.

data
object

A document rendered to markdown.

reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"