> ## Documentation Index
> Fetch the complete documentation index at: https://docs.custral.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a document

> Replace an existing document's content with markdown, by its `doc_…` id. Update-only — an unknown id returns `404 document_not_found`, never a silent create. The write merges into the document's live state, so it lands in any open editor. **Requires scope:** `documents:write`.



## OpenAPI

````yaml /openapi-v1.json patch /v1/documents/{id}
openapi: 3.1.0
info:
  title: Custral API
  version: v1
  description: >-
    The curated, versioned, API-key-authenticated public REST surface (`/v1`).
    Every endpoint here is what the official SDKs (`@custral/sdk`) and the MCP
    server are built on. Authenticate with a secret API key (`sk_…`) created in
    **Settings → Applications**.
  contact:
    name: Custral Support
    email: hello@custral.com
    url: https://custral.com
  license:
    name: Proprietary
    url: https://custral.com
servers:
  - url: https://api.custral.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Identity
    description: Introspect the calling API key.
  - name: Records
    description: Create, list, retrieve, and update records on any object.
  - name: Objects
    description: Read the object (table) schema of your workspace.
  - name: Conversations
    description: View, manage, and ingest conversations and their messages.
  - name: MCP
    description: Introspect the Model Context Protocol tool surface for a key.
  - name: Documents
    description: Read record notes / page documents as markdown.
paths:
  /v1/documents/{id}:
    patch:
      tags:
        - Documents
      summary: Update a document
      description: >-
        Replace an existing document's content with markdown, by its `doc_…` id.
        Update-only — an unknown id returns `404 document_not_found`, never a
        silent create. The write merges into the document's live state, so it
        lands in any open editor. **Requires scope:** `documents:write`.
      operationId: updateDocument
      parameters:
        - name: id
          in: path
          required: true
          description: The document id (`doc_…`).
          schema:
            type: string
          example: doc_123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDocumentBody'
      responses:
        '200':
          description: The updated document.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Document'
                  reqId:
                    $ref: '#/components/schemas/RequestId'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    UpdateDocumentBody:
      type: object
      description: The body of an update-document request. The document id is in the path.
      properties:
        content:
          type: string
          description: >-
            The new document body, as markdown. Replaces the document's content
            in full.
          example: |-
            ## Notes

            Updated by the integration.
      required:
        - content
    Document:
      type: object
      description: A document rendered to markdown.
      properties:
        id:
          type: string
          example: doc_123
        markdown:
          type: string
          description: The document content as markdown.
          example: |-
            ## Bug

            Repro steps…
      required:
        - id
        - markdown
    RequestId:
      type: string
      description: >-
        A per-request id (`req_…`). Quote it to support when reporting a
        problem.
      example: req_2a1f9c8e7b6d5
    Error:
      type: object
      description: >-
        The failure envelope. Every error carries a machine-readable `code` and
        the `reqId` of the failing request.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: insufficient_scope
          required:
            - code
        reqId:
          $ref: '#/components/schemas/RequestId'
      required:
        - error
  responses:
    Unauthorized:
      description: >-
        The API key is missing, unknown, inactive, or expired (`code:
        invalid_api_key`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_api_key
            reqId: req_2a1f9c8e7b6d5
    Forbidden:
      description: >-
        The key lacks the scope this endpoint requires (`code:
        insufficient_scope`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: insufficient_scope
            reqId: req_2a1f9c8e7b6d5
    NotFound:
      description: 'The object or record was not found (`code: not_found`).'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
            reqId: req_2a1f9c8e7b6d5
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: sk_...
      description: >-
        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.

````

## Related topics

- [The Document object](/dev/api-reference/documents.md)
- [Product Updates](/product/overview.md)
- [Update a record](/api-reference/records/update-a-record.md)
- [Real-time updates](/dev/realtime/overview.md)
- [Update status & outcome](/api-reference/conversations/update-status-&-outcome.md)