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

# Update alerts: confirm, mark as false alarm, skip, move back to review, add to or remove from a claim, move to another topic

> Sets the verdict, dismissal, claim or topic of the selected alerts, with the same fields as PATCH /v1/alerts/{id}. Only the fields you send change, and each changes only itself: setting a claim does not confirm, a verdict does not touch claims or credit. A false alarm (verdict dismissed) needs a dismissal category and starts a run that suggests improvements to the agreement's instructions, unless suggest_instructions is false; once no alert keeps that false alarm, because its alerts took another verdict or a new reason, its suggestions nobody has reviewed are withdrawn. A claim can hold alerts of any verdict but asks only for accepted ones. To stop Watchdog flagging a kind of deviation again, teach the agreement a rule with POST /v1/agreements/{id}/teach. Select alerts with alert_ids or filter, at most 5000 per request. Retrying is safe. A filter must name topics, claims, agreements or invoices. Alerts in completed claims keep their verdict and claim.



## OpenAPI

````yaml /openapi.json post /v1/alerts/update
openapi: 3.1.0
info:
  title: Watchdog API
  version: 1.0.0
  description: >-
    The Watchdog API is served from https://api.watchdog.no. Request bodies are
    limited to 2 MiB unless an endpoint says otherwise. Files are uploaded
    directly to storage, not through the API.
servers:
  - url: https://api.watchdog.no
    description: Watchdog API
security: []
paths:
  /v1/alerts/update:
    post:
      tags:
        - Alerts
      summary: >-
        Update alerts: confirm, mark as false alarm, skip, move back to review,
        add to or remove from a claim, move to another topic
      description: >-
        Sets the verdict, dismissal, claim or topic of the selected alerts, with
        the same fields as PATCH /v1/alerts/{id}. Only the fields you send
        change, and each changes only itself: setting a claim does not confirm,
        a verdict does not touch claims or credit. A false alarm (verdict
        dismissed) needs a dismissal category and starts a run that suggests
        improvements to the agreement's instructions, unless
        suggest_instructions is false; once no alert keeps that false alarm,
        because its alerts took another verdict or a new reason, its suggestions
        nobody has reviewed are withdrawn. A claim can hold alerts of any
        verdict but asks only for accepted ones. To stop Watchdog flagging a
        kind of deviation again, teach the agreement a rule with POST
        /v1/agreements/{id}/teach. Select alerts with alert_ids or filter, at
        most 5000 per request. Retrying is safe. A filter must name topics,
        claims, agreements or invoices. Alerts in completed claims keep their
        verdict and claim.
      operationId: updateAlerts
      parameters:
        - name: X-Organization-Id
          in: header
          required: false
          schema:
            type: string
          description: >-
            The organization to act in. Required for personal API keys; list the
            organizations you can access with GET /v1/organizations.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                alert_ids:
                  type: array
                  items:
                    type: string
                    format: uuid
                  minItems: 1
                  maxItems: 5000
                  description: >-
                    Alerts to change. If any is unknown (404) or cannot be
                    changed (409), nothing changes.
                filter:
                  $ref: '#/components/schemas/AlertFilter'
                excluded_alert_ids:
                  type: array
                  items:
                    type: string
                    format: uuid
                  minItems: 1
                  maxItems: 5000
                  description: >-
                    Alerts to leave out of a filter selection. Only valid with
                    filter.
                verdict:
                  type: string
                  enum:
                    - pending
                    - accepted
                    - dismissed
                    - skipped
                  description: >-
                    Whether the finding is right. pending: still to review.
                    accepted: confirmed, the deviation is real (also when it is
                    too small to pursue or already handled). dismissed: a false
                    alarm, Watchdog was wrong; requires dismissal with a
                    category. skipped (shown as Unsure): nobody can or will
                    judge it; it leaves review without teaching anything. Claim
                    membership and credit are not changed. Leaving dismissed
                    takes the dismissal off the alert; it stays in the history.
                dismissal:
                  type: object
                  properties:
                    category:
                      type: string
                      enum:
                        - misread
                        - missing_context
                        - duplicate
                        - other
                      description: >-
                        Why Watchdog was wrong. misread: it misread the
                        agreement or the invoice. missing_context: it lacked
                        information it could not see, such as a side agreement
                        or a price change agreed by email. duplicate: it flagged
                        the same deviation twice. other: explain in note. An
                        alert that is right but not worth pursuing, or already
                        handled, is confirmed (accepted), not a false alarm.
                    note:
                      type:
                        - string
                        - 'null'
                      maxLength: 2000
                      description: >-
                        What Watchdog got wrong, in your own words. Required
                        with category other.
                  required:
                    - category
                  additionalProperties: false
                  description: >-
                    Why the alerts are false alarms. Required with verdict
                    dismissed, and only valid with it. Sending a different
                    reason for an already dismissed alert replaces its reason.
                suggest_instructions:
                  type: boolean
                  description: >-
                    Whether the false alarm should start a run that suggests
                    changes to the agreement's instructions, so later checks
                    avoid the mistake. Defaults to true. Send false when the
                    note explains a cleanup rather than a rule for future
                    checks. Only valid with verdict dismissed; it is not stored
                    on the alert.
                claim_id:
                  type:
                    - string
                    - 'null'
                  format: uuid
                  description: >-
                    Put the alerts in this pending or in-progress claim of their
                    agreement, or null to take them out of their claim. Verdicts
                    are not changed: send verdict accepted to accept them too.
                    Alerts move out of a cancelled claim; out of another open
                    claim only with move_from_open_claims. Alerts in completed
                    claims cannot be changed. POST /v1/claims/alerts/preview
                    says first which alerts would join and why the others would
                    not.
                move_from_open_claims:
                  type: boolean
                  description: >-
                    Move alerts out of other pending or in-progress claims. Only
                    valid with a claim_id.
                topic_id:
                  type:
                    - string
                    - 'null'
                  format: uuid
                  description: >-
                    Move the alerts into this topic of their agreement, out of
                    any other topic, or null to take them out of their topic.
                    Categorization may later place an alert without a topic in
                    one again.
              additionalProperties: false
      responses:
        '200':
          description: >-
            How many alerts changed and how many matching alerts were left
            alone.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertSelectionResult'
        '400':
          description: >-
            The request is invalid. details lists up to 20 field errors. Request
            bodies are limited to 2 MiB.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: >-
                    The request is invalid. details lists up to 20 field errors.
                    Request bodies are limited to 2 MiB.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_validation_error'
        '401':
          description: The bearer token is missing or invalid.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            WWW-Authenticate:
              schema:
                type: string
              required: false
              description: Bearer authentication challenge, when supplied.
          content:
            application/json:
              example:
                error:
                  code: invalid_token
                  message: The bearer token is missing or invalid.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_invalid_token'
        '403':
          description: >-
            Access denied. The error code says why: forbidden, token_disabled,
            organization_required, insufficient_role or mfa_required.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: forbidden
                  message: >-
                    Access denied. The error code says why: forbidden,
                    token_disabled, organization_required, insufficient_role or
                    mfa_required.
                  request_id: req_example
              schema:
                $ref: >-
                  #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required
        '404':
          description: >-
            An alert in alert_ids, the claim, the topic or a selected View was
            not found.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: not_found
                  message: >-
                    An alert in alert_ids, the claim, the topic or a selected
                    View was not found.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_not_found'
        '409':
          description: >-
            An alert in alert_ids cannot be changed (for example, it is in a
            completed claim or another open claim), the filter selects too many
            alerts, or a selected View has invalid saved filters. Nothing
            changed.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: conflict
                  message: >-
                    An alert in alert_ids cannot be changed (for example, it is
                    in a completed claim or another open claim), the filter
                    selects too many alerts, or a selected View has invalid
                    saved filters. Nothing changed.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_conflict'
        '429':
          description: Too many requests. Wait for the Retry-After delay before retrying.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Wait for the Retry-After delay before
                    retrying.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_rate_limit_exceeded'
        '500':
          description: >-
            Unexpected server failure. Include the request ID when contacting
            support.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: internal_error
                  message: >-
                    Unexpected server failure. Include the request ID when
                    contacting support.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_internal_error'
        '503':
          description: >-
            Temporarily unavailable. Retry after the Retry-After delay, when
            provided.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              example:
                error:
                  code: service_unavailable
                  message: >-
                    Temporarily unavailable. Retry after the Retry-After delay,
                    when provided.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_service_unavailable'
      security:
        - ApiKeyBearer: []
components:
  schemas:
    AlertFilter:
      type: object
      properties:
        view_ids:
          type: array
          items:
            type: string
        claim_ids:
          type: array
          items:
            type: string
        has_claim:
          type: boolean
          description: Attached to a claim now.
        claim_statuses:
          type: array
          items:
            type: string
            enum:
              - pending
              - in_progress
              - completed
              - cancelled
          description: Of the current claim.
        invoice_ids:
          type: array
          items:
            type: string
            format: uuid
        company_ids:
          type: array
          items:
            type: string
            format: uuid
          description: >-
            Alerts on invoices of these workspace companies: a company scope,
            applied to every alert whatever join_operator says.
        agreement_ids:
          type: array
          items:
            type: string
            format: uuid
        purchase_order_ids:
          type: array
          items:
            type: string
            format: uuid
          description: Alerts of purchase-order checks against these orders.
        agreement_statuses:
          type: array
          items:
            type: string
            enum:
              - draft
              - active
              - archived
        supplier_ids:
          type: array
          items:
            type: string
            format: uuid
        recipient_ids:
          type: array
          items:
            type: string
            format: uuid
        tag_ids:
          type: array
          items:
            type: string
            format: uuid
          description: Tags of the agreement.
        topic_ids:
          type: array
          items:
            type: string
        has_topic:
          type: boolean
        check_types:
          type: array
          items:
            type: string
            enum:
              - agreement
              - purchase_order
              - duplicate
        verdicts:
          type: array
          items:
            type: string
            enum:
              - pending
              - accepted
              - dismissed
              - skipped
          description: >-
            Whatever the credit. pending: to review; accepted: confirmed;
            dismissed: false alarm; skipped: unsure. Reviewed: all but pending.
        credited:
          type: boolean
          description: Whatever the verdict.
        confidence_levels:
          type: array
          items:
            type: string
            enum:
              - certain
              - uncertain
              - 'null'
        currency_codes:
          type: array
          items:
            type: string
            pattern: ^[A-Z]{3}$
        correction_types:
          type: array
          items:
            type: string
            enum:
              - modify_item
              - modify_invoice
              - add_item
        agreement_version_status:
          type: string
          enum:
            - current
            - older
          description: >-
            The alert assessed the current agreement version or an older one; an
            unknown version or no agreement matches neither.
        validity:
          type: string
          enum:
            - live
            - invalidated
            - all
          description: >-
            live (default): alerts that count; invalidated: those that stopped
            (invalidation.reason says why). Alerts in claims named by claim_ids
            are included either way.
        impact_min:
          type: string
          maxLength: 100
          pattern: ^-?\d+(?:\.\d+)?$
          description: >-
            Impact in the organization currency, inclusive. Alerts without one
            never match.
        impact_max:
          type: string
          maxLength: 100
          pattern: ^-?\d+(?:\.\d+)?$
        issued_from:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
          description: Invoice issue date.
        issued_through:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        created_from:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        created_through:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        search:
          type: string
          minLength: 1
          maxLength: 200
          description: >-
            Alert, invoice, supplier, agreement and topic text. A UUID matches
            the alert, invoice, supplier or agreement ID.
        join_operator:
          type: string
          enum:
            - and
            - or
          description: >-
            or combines only the invoice, agreement, supplier, recipient and
            topic IDs.
        not:
          type: array
          items:
            type: string
            enum:
              - claim_ids
              - claim_statuses
              - invoice_ids
              - agreement_ids
              - purchase_order_ids
              - agreement_statuses
              - supplier_ids
              - recipient_ids
              - tag_ids
              - topic_ids
              - check_types
              - verdicts
              - confidence_levels
              - currency_codes
              - correction_types
          description: List filters to invert.
      additionalProperties: false
    AlertSelectionResult:
      type: object
      properties:
        changed_count:
          type: integer
          description: >-
            Alerts the command changed. Alerts already in the requested state
            are not counted.
        skipped_count:
          type: integer
          description: Matching alerts a filter left unchanged. Always 0 for alert_ids.
      required:
        - changed_count
        - skipped_count
    Error_validation_error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_error
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_invalid_token:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_token
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - forbidden
                - token_disabled
                - organization_required
                - insufficient_role
                - mfa_required
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_not_found:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - not_found
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_conflict:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - conflict
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_rate_limit_exceeded:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - rate_limit_exceeded
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_internal_error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - internal_error
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_service_unavailable:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - service_unavailable
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      description: >-
        Personal API key sent as a bearer token, together with
        X-Organization-Id. The key must have at least the access level the
        endpoint requires (read, write or admin).

````

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