# AUTO-GENERATED tier-A mirror spec — do not edit.
# Source: openapi/runtime/approvals.yaml (runtime 0.124.0)
#  + policy: openapi/mirror-policies/approvals.json
# Regenerate: node scripts/generate-mirror-specs.mjs
openapi: 3.0.3
info:
  title: naturali.ai — Approvals API
  version: 1.0.0
  description: >-
    Approvals: the human decisions a run is waiting on — the queue of pending requests, the
    recurrences that show what keeps asking, and the approve/reject calls that let a paused run
    continue. A fully runtime-backed module — this spec is generated verbatim from the runtime's
    own, re-rooted under /v1/projects/{project_id}. The project in the path is authorized by
    naturali and enforced upstream by the project's scoped credential.


    This module mirrors the upstream runtime verbatim (tier A): paths are the runtime's own
    re-rooted under /v1/projects/{project_id}, and every field, method, status code and error shape
    passes through unchanged. Errors raised by the runtime arrive in its envelope; errors raised by
    naturali itself (authentication, project resolution, an unreachable runtime) use naturali's.
  contact:
    name: naturali.ai
    url: https://naturali.ai
servers:
  - url: "{baseUrl}"
    description: Host of your naturali.ai deployment; every path carries the /v1 prefix.
    variables:
      baseUrl:
        description: Base host URL.
        default: https://api.naturali.ai
tags:
  - name: Approvals
    description: Manage the human-decision approval queue
security:
  - bearerAuth: []
  - oauth2:
      - mcp:access
paths:
  /v1/projects/{project_id}/approvals:
    get:
      tags:
        - Approvals
      summary: List approval items
      description: Returns approval items for a project, filterable by status, origin, and expiry.
      operationId: listApprovals
      parameters:
        - name: status
          in: query
          required: false
          description: Filter by lifecycle status. Repeat the parameter to OR values. A value outside the
            enum, empty string included, is a `400`.
          schema:
            type: array
            items:
              type: string
              enum:
                - pending
                - approved
                - rejected
                - expired
          style: form
          explode: true
        - name: origin
          in: query
          description: Filter by producer origin
          schema:
            type: string
            enum:
              - node
              - tool_call
              - task_transition
        - name: expires_from
          in: query
          description: Only items whose `expires_at` is at or after this timestamp (ISO 8601)
          schema:
            type: string
            format: date-time
        - name: expires_to
          in: query
          description: Only items whose `expires_at` is at or before this timestamp (ISO 8601)
          schema:
            type: string
            format: date-time
        - $ref: "#/components/parameters/Limit"
        - $ref: "#/components/parameters/Cursor"
      responses:
        "200":
          description: List of approval items
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/Page"
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: "#/components/schemas/ApprovalItem"
        "400":
          description: Invalid `status` or `origin` filter value, or an `expires_from` / `expires_to` that is
            not an ISO 8601 timestamp
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          $ref: "#/components/responses/ProjectNotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
    parameters:
      - $ref: "#/components/parameters/ProjectId"
  /v1/projects/{project_id}/approvals/recurrences:
    get:
      tags:
        - Approvals
      summary: List recurring approval groups
      description: Read-only rollup answering "what keeps coming back?" — groups items by `dedup_key` and
        returns those recurring at least `min_count` times, most-recurrent first. Each group carries
        the ordered item chain (via `previous_item_id`) and the resolution reasons in order, so a
        human can read recurring rejections side by side and graduate the pattern into a guardrail
        `deny`. Exact-key grouping only; no cluster state is stored.
      operationId: listApprovalRecurrences
      parameters:
        - name: status
          in: query
          required: false
          description: Lifecycle statuses the groups are built from (default `rejected`). Repeat the parameter
            to OR values. A value outside the enum, empty string included, is a `400`.
          schema:
            type: array
            items:
              type: string
              enum:
                - pending
                - approved
                - rejected
                - expired
            default:
              - rejected
          style: form
          explode: true
        - name: min_count
          in: query
          description: Minimum items in a group for it to be returned
          schema:
            type: integer
            default: 2
            minimum: 1
        - $ref: "#/components/parameters/Limit"
        - $ref: "#/components/parameters/Cursor"
      responses:
        "200":
          description: List of recurrence groups
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/Page"
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: "#/components/schemas/ApprovalRecurrenceGroup"
        "400":
          description: Invalid `status` filter value
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          $ref: "#/components/responses/ProjectNotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
    parameters:
      - $ref: "#/components/parameters/ProjectId"
  /v1/projects/{project_id}/approvals/{approval_id}:
    get:
      tags:
        - Approvals
      summary: Get an approval item
      description: Returns a single approval item with its full evidence.
      operationId: getApproval
      parameters:
        - $ref: "#/components/parameters/approval_id"
      responses:
        "200":
          description: Approval item
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApprovalItem"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Approval item not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
    parameters:
      - $ref: "#/components/parameters/ProjectId"
  /v1/projects/{project_id}/approvals/{approval_id}/approve:
    post:
      tags:
        - Approvals
      summary: Approve an approval item
      description: Approves the item. Optionally supply edited `arguments` to replace the proposed
        arguments (edit-then-approve); the original is preserved on the item. Expiry is re-checked
        at decision time — an expired item can never be approved.
      operationId: approveApproval
      x-naturali-agent-exclude: true
      parameters:
        - $ref: "#/components/parameters/approval_id"
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                arguments:
                  type: object
                  description: Edited arguments to execute instead of the proposed ones. Editing composes a new call
                    to the tool. Refused on an item with no `proposed_action`.
                tool_context:
                  type: object
                  additionalProperties:
                    type: string
                  description: "Key-value pairs forwarded as context headers on the approved action and on every tool
                    call of the continuation turn, as on a generation's `tool_context`. Never stored
                    on the item: supply it on the approve call itself, for a tool that authorizes
                    with a credential minted at decision time. The server-pinned identity keys
                    (`session_id`, `actor_id`, `actor_external_id`) are dropped. An invalid or
                    colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY` and nothing is
                    resolved."
      responses:
        "200":
          description: Approval item approved
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApprovalItem"
        "400":
          description: Edited arguments are not a JSON object, do not satisfy the tool's parameters schema, or
            are sent for an item with no `proposed_action`; or a `tool_context` key is not a valid
            header name
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden — including an edit by a caller who may resolve the item but not make the
            call it proposes
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Approval item not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "409":
          description: Item already resolved or expired
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "413":
          $ref: "#/components/responses/PayloadTooLarge"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
        "502":
          $ref: "#/components/responses/AdmissionUnavailable"
        4XX:
          $ref: "#/components/responses/AdmissionRefused"
    parameters:
      - $ref: "#/components/parameters/ProjectId"
  /v1/projects/{project_id}/approvals/{approval_id}/reject:
    post:
      tags:
        - Approvals
      summary: Reject an approval item
      description: Rejects the item. A reason is required and preserved on the item.
      operationId: rejectApproval
      x-naturali-agent-exclude: true
      parameters:
        - $ref: "#/components/parameters/approval_id"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - reason
              additionalProperties: false
              properties:
                reason:
                  type: string
                  description: Why the item is being rejected (required)
                  example: Amount exceeds the approved monthly budget.
      responses:
        "200":
          description: Approval item rejected
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApprovalItem"
        "400":
          description: Reason missing
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Approval item not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "409":
          description: Item already resolved or expired
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "413":
          $ref: "#/components/responses/PayloadTooLarge"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
        "502":
          $ref: "#/components/responses/AdmissionUnavailable"
        4XX:
          $ref: "#/components/responses/AdmissionRefused"
    parameters:
      - $ref: "#/components/parameters/ProjectId"
components:
  schemas:
    ApprovalRecurrenceGroup:
      type: object
      description: A set of approval items sharing a `dedup_key` — the same proposed action recurring —
        with the ordered chain and its resolution reasons.
      properties:
        dedup_key:
          type: string
          description: The shared dedup key that defines the group
        agent_id:
          type: string
          nullable: true
          description: Proposing agent (shared across the group)
        tool_id:
          type: string
          nullable: true
          description: Proposed tool (shared across the group)
        count:
          type: integer
          description: Number of items in the group
        chain:
          type: array
          description: The items oldest → newest (the `previous_item_id` chain)
          items:
            type: object
            properties:
              id:
                type: string
                example: apr_V1StGXR8Z5jdHi6B
              status:
                type: string
                enum:
                  - pending
                  - approved
                  - rejected
                  - expired
              resolution_reason:
                type: string
                nullable: true
              created_at:
                type: string
                format: date-time
        reasons:
          type: array
          description: The chain's resolution reasons in order (empty entries omitted)
          items:
            type: string
    ApprovalItem:
      type: object
      properties:
        id:
          type: string
          example: apr_V1StGXR8Z5jdHi6B
        project_id:
          x-naturali-ref: projects
          type: string
        origin:
          type: string
          enum:
            - node
            - tool_call
            - task_transition
          description: How the item was produced (analytics/filtering only)
        status:
          type: string
          enum:
            - pending
            - approved
            - rejected
            - expired
        proposed_action:
          type: object
          nullable: true
          description: The frozen proposed action. Null for producers whose proposal is not a tool call (a
            `task_transition` item gates a workflow transition, named by `task_transition`).
          properties:
            tool_id:
              type: string
            action:
              type: string
              description: Resolved action name (the builtin/mcp action) for `tool_call`-origin items — always
                present there, even for single-action tools. Omitted for `node`-origin items, whose
                downstream execution is wired by a separate `tool` node in the graph.
            arguments:
              type: object
        reasoning:
          type: string
          nullable: true
          description: The proposing agent's rationale
        evidence:
          type: object
          nullable: true
          description: Supporting structured data
        predicted_impact:
          type: string
          nullable: true
          description: Expected execution effect
        expires_at:
          type: string
          format: date-time
          description: Server-enforced hard gate; the item can never execute after this
        dedup_key:
          type: string
          nullable: true
          description: Set on tool-call items to suppress duplicate proposals
        orchestration_run_id:
          type: string
          nullable: true
          description: Originating orchestration run (node producer)
        node_id:
          type: string
          nullable: true
          description: Originating node id within the run's graph
        generation_id:
          type: string
          nullable: true
          description: Originating generation (tool-call producer)
        session_id:
          type: string
          nullable: true
          description: Session the originating generation ran in (tool-call producer)
        agent_id:
          type: string
          nullable: true
          description: Proposing agent
        task_id:
          type: string
          nullable: true
          description: Gated task (task_transition producer)
        task_transition:
          type: string
          nullable: true
          description: Transition fired on approval (task_transition producer)
        policy_version:
          type: string
          nullable: true
        previous_item_id:
          type: string
          nullable: true
          description: Prior item's ID when this proposal was re-filed after an earlier matching item (same
            dedup_key) had been rejected
          example: apr_V1StGXR8Z5jdHi6B
        resolved_by_principal_type:
          nullable: true
          allOf:
            - $ref: "#/components/schemas/PrincipalType"
          description: Who resolved the item; null while pending and on expiry.
        resolved_by_principal_id:
          type: string
          nullable: true
          description: "Public id of that principal: the user (`user_…`), or for API key auth the key itself
            (`key_…`), so the record names which key acted."
          example: user_V1StGXR8Z5jdHi6B
        resolution_reason:
          type: string
          nullable: true
          description: Required on rejection
        edited_arguments:
          type: object
          nullable: true
          description: Set on edit-then-approve
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Page:
      type: object
      description: One page of a list. Rows inserted or removed between two calls neither repeat nor skip
        a row on the next page.
      required:
        - data
        - next_cursor
      properties:
        data:
          type: array
          description: This page's items, in the list's order.
          items: {}
        next_cursor:
          type: string
          nullable: true
          description: Pass as `cursor` to fetch the next page; `null` on the last page.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          description: Structured error. Every error response uses this shape, so `code` can be read without
            first checking the type of `error`.
          required:
            - code
            - message
            - hint
          properties:
            code:
              type: string
              pattern: ^[A-Z][A-Z0-9_]*$
              description: Machine-readable error code, UPPER_SNAKE whether naturali or the runtime raises it.
              example: FORBIDDEN
            message:
              type: string
              description: Human-readable explanation.
              example: Your role in this project does not carry this action.
            hint:
              type: string
              description: What to do about it, naming the routes of this API to call. For people and agents; it
                may change, so branch on `code`.
              example: Use a credential whose scope includes this action, or ask a project `admin` or `owner` to
                act; the caller's role or key excludes it.
            meta:
              type: object
              additionalProperties: true
              description: Structured context, such as the `resource` and `limit` of a `PLAN_LIMIT_REACHED`.
    PrincipalType:
      type: string
      enum:
        - user
        - api_key
        - agent
        - automation
        - approval
        - trigger
        - system
        - eval
        - decider
        - ingestion_rule
        - memory_rule
        - playbook_version
      description: What kind of principal acted. `user` and `api_key` are authenticated callers, and the
        id is the user's (`user_…`) or the key's own (`key_…`), so a record names which key acted
        rather than its owner. `agent` is an agent writing under its own identity (`agent_…`).
        `automation` is the task engine acting on a dispatch outcome and `approval` an approval
        resolution; neither carries an id. `trigger` is a trigger firing under its own `policy_ids`
        (`trg_…`). `system` is the platform itself, with an id naming the mechanism
        (`retention_sweep`, `zero_retention`). `eval`, `decider`, `ingestion_rule`, `memory_rule`
        and `playbook_version` are that resource's work running under its own `policy_ids` when
        nobody started it, the id its own.
      example: user
  parameters:
    ProjectId:
      name: project_id
      in: path
      required: true
      description: Project public ID (proj_ prefix).
      schema:
        type: string
        example: proj_V1StGXR8Z5jdHi6B
    approval_id:
      name: approval_id
      in: path
      required: true
      description: Approval item ID
      schema:
        type: string
        example: apr_V1StGXR8Z5jdHi6B
    Limit:
      name: limit
      in: query
      required: false
      description: Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an
        integer it is `400`.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
    Cursor:
      name: cursor
      in: query
      required: false
      description: The previous page's `next_cursor`; omit it for the first page. A cursor this list did
        not issue is `400`.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A naturali API key (nat_sk_…) or a session JWT.
    oauth2:
      type: oauth2
      description: "A connected app's OAuth access token, issued by this API's authorization server
        (discovery: /.well-known/oauth-authorization-server). Its one scope carries every operation,
        confined to the projects the user chose when approving the app."
      flows:
        authorizationCode:
          authorizationUrl: https://api.naturali.ai/authorize
          tokenUrl: https://api.naturali.ai/token
          refreshUrl: https://api.naturali.ai/token
          scopes:
            mcp:access: Every operation this API serves, on the projects the grant covers.
  responses:
    TooManyRequests:
      description: "`QUOTA_EXCEEDED` — a `requests` quota on the calling API key or its project is spent
        for the window; `Retry-After` says when it reopens"
      headers:
        Retry-After:
          description: Seconds until the quota window admits a request again
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    BadRequest:
      description: The request was malformed or failed validation.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    InternalError:
      description: Unexpected server error — `INTERNAL_ERROR`, with the raw message never forwarded
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    PayloadTooLarge:
      description: "`REQUEST_REJECTED` — the request body is over the size the body parser accepts"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    AdmissionUnavailable:
      description: The deployment's admission service is asked about this write and did not answer —
        `ADMISSION_UNAVAILABLE`; the write did not happen
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    AdmissionRefused:
      description: The deployment's admission service refused this write — answered under the service's
        own `4xx` status, with its `code` (matching `^[A-Za-z_][A-Za-z0-9_]{0,63}$`, not necessarily
        an `ERROR_CODES` key), `message` and `meta`; the write did not happen. A status this
        operation also declares on its own is documented there
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    ProjectNotFound:
      description: The project does not exist or the caller is not a member of it (`RESOURCE_NOT_FOUND`).
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
