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

# See what changed

> What an edit or a hand-saved file added, changed or removed, with the text before and after.



## OpenAPI

````yaml /openapi.json get /documents/{document_id}/report
openapi: 3.1.0
info:
  title: Doconda API
  version: 0.1.0
  license:
    name: Proprietary
    url: https://doconda.com/terms
  description: >-
    Convert, create and edit Word, PowerPoint, Excel and PDF documents for AI
    agents. `POST /documents` waits for the document (direct, the default) or
    answers at once with `background: true`.

    Errors follow RFC 9457 (application/problem+json). `POST /documents` accepts
    `Idempotency-Key`.
servers:
  - url: https://api.eu.doconda.com/v1
security:
  - apiKey: []
tags:
  - name: Documents
    description: Create and edit documents.
  - name: Files
    description: 'Your own files: convert them, or use them as a source or to edit.'
  - name: Webhooks
    description: Be notified when a document is ready.
  - name: Editor
    description: Calls your backend makes for the editor plugin.
  - name: Dashboard
    description: >-
      Used by the Doconda dashboard with a signed-in user. Not available with
      API keys.
paths:
  /documents/{document_id}/report:
    get:
      tags:
        - Documents
      summary: What an edit changed
      operationId: getDocumentReport
      parameters:
        - name: document_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Report.
          content:
            application/json:
              schema:
                type: object
                properties:
                  document_id:
                    type: string
                    pattern: ^doc_[0-9A-HJKMNP-TV-Z]{26}$
                  changes:
                    type: array
                    items:
                      type: object
                      properties:
                        change:
                          type: string
                          enum:
                            - added
                            - changed
                            - removed
                        before:
                          type: array
                          items:
                            type: string
                        after:
                          type: array
                          items:
                            type: string
                      required:
                        - change
                        - before
                        - after
                    description: >-
                      What an edit changed (by Doconda, or by hand in a saved
                      version): the paragraphs, cells or slide texts added,
                      changed or removed. Empty for a document that was created.
                  changes_truncated:
                    type: boolean
                    description: >-
                      true when `changes` was cut at 3,000 paragraphs, cells or
                      slide texts in all: the edit changed more than that.
                required:
                  - document_id
                  - changes
                  - changes_truncated
        '401':
          description: unauthorized (missing, unknown or revoked key; expired session).
          content:
            application/problem+json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  code:
                    type: string
                    description: >-
                      Stable machine code, e.g. input_invalid,
                      insufficient_balance.
                  request_id:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                      required:
                        - path
                        - message
                required:
                  - type
                  - title
                  - status
                  - code
                  - request_id
        '404':
          description: not_found
          content:
            application/problem+json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  code:
                    type: string
                    description: >-
                      Stable machine code, e.g. input_invalid,
                      insufficient_balance.
                  request_id:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                      required:
                        - path
                        - message
                required:
                  - type
                  - title
                  - status
                  - code
                  - request_id
        '409':
          description: 'report_not_ready: available once the document has finished.'
          content:
            application/problem+json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  code:
                    type: string
                    description: >-
                      Stable machine code, e.g. input_invalid,
                      insufficient_balance.
                  request_id:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                      required:
                        - path
                        - message
                required:
                  - type
                  - title
                  - status
                  - code
                  - request_id
      security:
        - apiKey: []
        - session: []
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: '`Authorization: Bearer ak_eu_…`, a key from the dashboard (API keys).'
    session:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Dashboard only: the Cognito ID token of the signed-in user.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.