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

# Install the exact measured native candidate atomically

> Requires delegated reports:write consent, current native edit permission and workspace authoring availability. Data is independently authorized: composition consumes readable pinned outputs and never executes providers. A sealed stage is composed and measured in its declared fixed or responsive mode; the saved report changes only through atomic measured-plan commit. Read all finding pages and explicitly acknowledge required advisories. Creation streams at most 16 KiB; commit streams at most 32 MiB. Current-input checks and exact revision/hash guards reject moved inputs without rebasing. Identical commit retries return the original receipt after later edits or temporary-plan cleanup. Publication is separate. Workspace service keys are unsupported.

Required scopes: `reports:write`.


## OpenAPI

````yaml POST /api/v2/reports/canvas/plans/{planId}/commit
openapi: 3.1.1
info:
  title: chatobserver public API
  version: '2026-09-09'
  description: >-
    Track AI visibility, manage prompts, inspect collected answers and
    citations, and integrate workspace data with your own tools. Visibility
    endpoints use workspace API keys. Data endpoints use scoped service-account
    keys; spreadsheet client endpoints use authorised client sessions. See the
    authentication guide for each credential type.
  contact:
    name: chatobserver support
    url: https://chatobserver.com/contact
    email: support@chatobserver.com
servers:
  - url: https://app.chatobserver.com
    description: Production API
security:
  - WorkspaceKey: []
  - BearerKey: []
tags:
  - name: Workspace
    description: Validate access and list the workspace project and available platforms.
  - name: Prompts
    description: Create, schedule, organise, activate and retrieve tracked prompts.
  - name: Answers
    description: Retrieve collected AI answers, their analysis and visibility trends.
  - name: Brands
    description: Manage brands and compare their visibility in AI answers.
  - name: Sources and citations
    description: Analyse cited domains, pages and ownership across answers.
  - name: Visitor analytics
    description: Read website visitor and crawler analytics for the workspace.
  - name: Content opportunities
    description: Retrieve content-gap findings and recommendations for tracked prompts.
  - name: Usage
    description: Read workspace consumption and allowance summaries.
  - name: Data connections
    description: Discover authorised connections, source accounts and connector catalogues.
  - name: Data queries
    description: >-
      Create versioned queries, publish definitions and inspect integration
      contracts.
  - name: Data operations
    description: >-
      Execute, validate, cancel and inspect operations and page through result
      rows.
  - name: Data delivery
    description: Manage schedules, transfers, destinations and import workflows.
  - name: Data definitions
    description: Manage reusable definitions and their immutable versions.
  - name: Data webhooks
    description: >-
      Configure event delivery, inspect deliveries, replay events and rotate
      secrets.
  - name: Client authorisation
    description: Authorise spreadsheet clients using a user-approved challenge exchange.
  - name: Spreadsheet clients
    description: >-
      Access document-bound client sessions, queries, schedules, bindings and
      write claims.
  - name: AI visibility audits
    description: Create website visibility audits and retrieve their report links.
  - name: Version 1
    description: Integrate with the version 1 visibility and analytics endpoints.
  - name: Tracked coverage
    description: >-
      Track published coverage, maintain its metadata and inspect exact-page
      citation evidence with the same workspace feature access as the dashboard.
  - name: Reports
    description: >-
      Discover accessible native reports and assess exact saved revisions using
      measured, context-specific evidence.
paths:
  /api/v2/reports/canvas/plans/{planId}/commit:
    post:
      tags:
        - Reports
      summary: Install the exact measured native candidate atomically
      description: >-
        Requires delegated reports:write consent, current native edit permission
        and workspace authoring availability. Data is independently authorized:
        composition consumes readable pinned outputs and never executes
        providers. A sealed stage is composed and measured in its declared fixed
        or responsive mode; the saved report changes only through atomic
        measured-plan commit. Read all finding pages and explicitly acknowledge
        required advisories. Creation streams at most 16 KiB; commit streams at
        most 32 MiB. Current-input checks and exact revision/hash guards reject
        moved inputs without rebasing. Identical commit retries return the
        original receipt after later edits or temporary-plan cleanup.
        Publication is separate. Workspace service keys are unsupported.
      operationId: commitCanvasPlan
      parameters:
        - name: x-workspace-id
          in: header
          required: true
          schema:
            type: string
            pattern: ^ws_[a-f0-9]{32}$
          description: Explicit workspace selected for the delegated account.
        - name: planId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportCompositionCommitRequestV1'
      responses:
        '200':
          description: Plan, committed receipt or identical creation retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportCompositionCommitResponseV1'
        default:
          description: >-
            Invalid request, denied access, changed inputs, semantic failure,
            expired plan or unavailable renderer. Preserve identical retry keys.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - McpConnection: []
components:
  schemas:
    ReportCompositionCommitRequestV1:
      type: object
      properties:
        planHash:
          type: string
          pattern: ^[0-9a-f]{64}$
        expectedRevision:
          type: integer
          minimum: 0
        expectedDocumentHash: 59193661-1fb7-473b-8465-98e93972d6e9
        expectedDependencyHash: cf7f950c-2609-450d-8238-756768b290ab
        acknowledgedAdvisoryIds:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 256
          maxItems: 100000
      required:
        - planHash
        - expectedRevision
        - expectedDocumentHash
        - expectedDependencyHash
        - acknowledgedAdvisoryIds
      additionalProperties: false
    ReportCompositionCommitResponseV1:
      type: object
      properties:
        data:
          type: object
          properties:
            version:
              type: number
              const: 1
            id:
              type: string
              format: uuid
            reportId:
              type: string
              format: uuid
            planId:
              type: string
              format: uuid
            planHash:
              type: string
              pattern: ^[0-9a-f]{64}$
            receiptHash: b468963d-8bbd-484c-b0e7-5e53893f843d
            idempotencyKey:
              type: string
              format: uuid
            committedAt:
              type: string
              format: date-time
            result:
              type: object
              properties:
                revision:
                  type: integer
                  exclusiveMinimum: 0
                documentHash: 5ae062c2-3060-455d-a220-389ab08f31fa
                nativeDocumentVersion:
                  type: number
                  const: 4
                checkpointId:
                  type: string
                  format: uuid
                operationBatchId:
                  type: string
                  format: uuid
              required:
                - revision
                - documentHash
                - nativeDocumentVersion
                - checkpointId
                - operationBatchId
              additionalProperties: false
          required:
            - version
            - id
            - reportId
            - planId
            - planHash
            - receiptHash
            - idempotencyKey
            - committedAt
            - result
          additionalProperties: false
        replayed:
          type: boolean
      required:
        - data
        - replayed
      additionalProperties: false
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          required:
            - code
            - message
        requestId:
          type: string
      required:
        - error
        - requestId
  securitySchemes:
    WorkspaceKey:
      type: apiKey
      in: header
      name: x-chatobserver-key
      description: >-
        A workspace API key. Data endpoints require a service-account key with
        the specified scopes.
    BearerKey:
      type: http
      scheme: bearer
      description: The workspace or service-account API key as a bearer token.
    McpConnection:
      type: http
      scheme: bearer
      description: >-
        Delegated application credential issued after Chatobserver account
        consent. Restricted to selected workspaces and explicitly supported MCP
        operations. The MCP server access token is a separate credential and
        cannot be used here.

````

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