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

# List Trust Fabric attention items

> Pages through the operator attention list of the deployment's organization, as the Forge Console Trust Fabric page shows it, decided at the deployment root. Requires permission `audit:read`, decided at the deployment root.

{/* forge-v2-compatibility-notes */}

> [!NOTE]
>
> The reference panel describes the current **v3** operation. The notes below describe its **v2 compatibility** API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

## v2 compatibility notes

Pages through the operator attention list — held calls, approvals, human workflow steps and agent
setup requests — as the Forge Console Trust Fabric page shows it for the deployment's organization.
Your credential's grants, narrowed to its scopes, must hold `audit:read` at your acting
organization and at the deployment root.

## Who reads as whom

* A **Personal key** reads as its owner, with the owner's visibility, and each item's `ability` is
  judged on the owner's grants narrowed to the key's scopes: a key can approve only a hold it could
  release itself, and a key whose scopes do not reach `approvals:approve` sees every item view-only.
* A **platform key** or an **External App** is no person: it sees the items an operator who is not an
  administrator sees, every one of them view-only (`canApprove` and `canReject` false).

## Parameters

| Parameter | Required | Meaning |
| - | - | - |
| `cursor` | No | The previous page's `meta.nextCursor`; any other value is `400` `Invalid cursor`. |
| `limit` | No | Items per page, 1 to 50 (default 25). |

`data.coverage` says how much of the attention sources the page proved; anything but `complete`
sets `meta.partial: true`.

## Example

```bash
curl "$FORGE_BASE/api/v2/governance/listAttention?limit=25" \
  -H "Authorization: Bearer $FORGE_TOKEN"
```

The response is `{ "data": { "items": [ … ], "coverage": { … }, "counts": { … } }, "meta": {
"requestId": "…", "hasMore": true, "nextCursor": "…", "partial": true } }`. Over MCP,
`forge_call_operation` with operationId `listAttention` returns the same `data` and `meta` as its `body`.


## OpenAPI

````yaml /forge/reference/openapi-v3.json get /api/v3/governance-attention-items
openapi: 3.1.0
info:
  title: Forge Platform API v3
  version: 0.23.0
  description: >-
    The Forge Platform API in its resource grammar: plural kebab-case
    collections, ids in the path, standard methods for the standard verbs and
    `POST …/{verb}` for the rest, and `/api/v3/me` for the caller's own records.
    Each operation is served by the same handler as the `/api/v2` operation it
    names: its operation id, credentials, permissions, refusals and idempotency
    are that operation's.
  contact:
    name: Forge Platform Team
servers:
  - url: https://api.forge.gloo.com
    description: Production
security:
  - BearerAuth: []
  - PlatformApiKey: []
  - PersonalKey: []
tags:
  - name: Agents
    description: >-
      Agent definitions: CRUD on the definition layer (create, get, list,
      update, delete) plus the A2A AgentCard endpoint, an agent's configuration,
      readiness and open setup request, the template gallery, the delegated work
      agents dispatched (sub-agent task runs and consultations), and agent
      administration: the kill switch, accountability repairs and setup
      requests.
  - name: Skills
    description: >-
      Skill definitions composed into agent prompts. List, fetch, and write
      skills owned by your External Application, and list and manage the skill
      sets that group them.
  - name: Tools
    description: >-
      Safe tool and tool-set catalog metadata and a tool's insights: the agents
      holding it, its calls, usage, history and sandbox rejections; workspace
      tool-set writes; no invocation.
  - name: Models
    description: Read-only access to the model catalog (provider, context window, status).
  - name: Workforce
    description: >-
      Organization units and positions in the caller’s workforce scope closure,
      and pods, pod membership previews and writes, pod lifecycle, ownership,
      internal profiles and Customer assignments, people (create, update, merge,
      offboard, reactivate), the worker directory, worker detail and seat
      budgets, assignment history, position assignment writes and the worker
      role list at the platform scope.
  - name: Objectives
    description: Read-only objective and key-result progress at the deployment root.
  - name: Planning
    description: >-
      Blueprint roadmaps, workstreams and milestones, and the critical-path and
      blocked-task projections, at the deployment root.
  - name: Projects
    description: Read-only project, customer relationship, and objective-link projections.
  - name: Workflows
    description: >-
      Workflow definitions and dispatch. List/get pinned workflow graphs and
      trigger runs by name.
  - name: Runs
    description: >-
      Workflow runs: list and read runs, their steps with runtime content,
      files, timeline, validator passes, recalled context, citations,
      notifications and governance status, the debug bundle, a Markdown export,
      agent conversations, the diagnostic timeline and AI analyses; cancel or
      restart a run, retry a failed notification, start an AI analysis and set a
      run's kill switch.
  - name: Chat
    description: >-
      Hybrid Workforce Chat — channels, sessions, and messages. Read
      channel/session state and post messages.
  - name: Memory
    description: >-
      Agent memory — channel and long-term layers. List, read, and write memory
      entries.
  - name: Knowledge
    description: >-
      Scoped knowledge: vector search, grounded answers, ingestion, entry reads
      and deletion. Every call is limited to the namespaces the credential may
      read or write, resolved server-side.
  - name: Factories
    description: >-
      Factory production units, their workers and tasks, spend and blueprints;
      operating a factory: messaging its manager agent and pausing, resuming or
      archiving it.
  - name: Sandboxes
    description: >-
      A run's sandboxes: recent runs that used them, the cached fleet summary, a
      run's lineage graph, its active sandboxes and a step's commands with
      masked output; diff two snapshots and replay a command against one in a
      fresh VM. Decided at the run's home and companies (factories:read; replay
      factories:manage).
  - name: Governance
    description: >-
      Approvals, policies and recorded decisions. List pending approvals, fetch
      detail, record decisions, list approval policies, list trust policies and
      their revisions, replay a trust policy against recorded decisions
      (historical, never an authorization), explain a recorded Trust Fabric
      decision, page recorded decision evidence, and read the permission catalog
      and role definitions.
  - name: Synthesis
    description: >-
      The synthesis queue: list and read synthesis requests, their Builder
      conversations and the procedures held for operator review, and promote,
      demote, accept or assign a reviewer to up to 50 requests per call. Decided
      at the platform scope.
  - name: Judges
    description: >-
      Machine judges: the judge catalog with metrics and rubrics, drift alerts,
      each judge's verdicts, pending primitive admissions, and the verdicts and
      live judge activity on a skill, agent, procedure, workflow draft or run.
      Decided at the platform scope.
  - name: Evals
    description: Evaluation sets and their runs.
  - name: External apps
    description: >-
      External Application registry: admin-only CRUD for the OAuth2 client
      credentials issued to integrating systems, an app's own record, and the
      agents an External App owns.
  - name: Costs and budgets
    description: >-
      Token spend and budgets. Bucketed and per-customer cost summaries are
      served from cron-populated rollups, so responses carry `meta.asOf`: an
      empty result with a null `asOf` means 'not accrued yet', not 'no spend'.
      Also agent and chat cost aggregates, the budget hierarchy, budget status
      and budget alerts.
  - name: Customers
    description: >-
      End-customer records, organizations and individuals. A customer row is
      shared across apps by `workosId`. The `/api/v2/external/customers` routes
      are an External Application's own view: per-app visibility comes from a
      `customerScopes` link, and those reads are fenced to the calling app. The
      `/api/v2/customers/*` routes are the organization's whole directory,
      decided at the deployment root for any credential holding `customers:read`
      there.
  - name: Procedures
    description: >-
      Read-only Procedures catalog — the deterministic, versioned units a
      workflow graph can bind. Compact projection only: never source code or
      bundled files.
  - name: Health
    description: Authenticated liveness check for integration smoke tests.
  - name: Capabilities
    description: >-
      Read-only deployment configuration: capability domains, their active
      provider chains, the provider catalog, credential health and a
      capability's recent changes. Decided at the deployment root; never
      credential values or option values.
  - name: Actor
    description: >-
      Request-scoped self-discovery: the calling credential's verified actor,
      its current narrowed permissions and each documented operation's advisory
      prerequisites.
  - name: API keys
    description: >-
      Personal keys and host sign-ins: a key owner lists and revokes their own;
      an administrator lists and revokes any person's.
  - name: Connections
    description: >-
      Connection credentials and the credential registry: list, create, review,
      revoke and delete credentials, and the vendors and connections they bind.
  - name: Email
    description: >-
      Inbound and outbound email: the outbox, received mail, the inbound ingress
      and its routes, and the sending domain.
  - name: Environments
    description: >-
      Environment Connections and their credentials: list, create, rename,
      replace the credential, and delete.
  - name: Identity
    description: >-
      Person profiles and avatars, and unmapped sign-in attempts waiting to be
      mapped or dismissed.
  - name: Notifications
    description: >-
      Notification event types with their payload fields, and the outbound Slack
      sends.
  - name: Observe and ops
    description: >-
      Operational reads: attention items, investigation notes, workflow
      performance and reliability overviews, failed runs, slow steps and a run's
      audit events.
  - name: Org units and positions
    description: >-
      The org chart: drafts that stage org unit and position changes, and the
      org units, positions and assignments they publish.
  - name: People and members
    description: >-
      People, their worker seats and org unit memberships, expertise tags, and
      the person-identity integrity check.
  - name: Projects and staffing
    description: Intake requests, their plans, and tasks across projects.
  - name: Roles and grants
    description: >-
      Job roles, the tools and skills they grant or deny, a holder's role
      grants, and AI-drafted role content.
  - name: Trust Fabric
    description: >-
      Governance controls and evidence: decisions, command tiers, trust
      assurance, policies, the governance door, the publish judge and the
      platform kill switch.
  - name: Vendors
    description: >-
      Vendors and their connections, attached API specs, generated client
      surfaces and remote MCP tool catalogs.
  - name: Webhooks
    description: >-
      Webhook subscriptions, deliveries and their attempts, replay and
      redelivery, dead letters, delivery health and the canonical event log.
  - name: Files
    description: >-
      Raw-byte file upload and authorized content redirects for uploaded files
      and readable run outputs.
  - name: Compliance
    description: >-
      Deployment-wide audit and governance record exports and a decision
      summary, for auditors holding `audit:read` at the deployment root.
paths:
  /api/v3/governance-attention-items:
    get:
      tags:
        - Governance
      summary: List Trust Fabric attention items
      description: >-
        Requires permission `audit:read`.


        Pages through the operator attention list of the deployment's
        organization, as the Forge Console Trust Fabric page shows it, decided
        at the deployment root. A Personal key reads as its owner; a platform
        key or an External App reads every item view-only. Each item's `ability`
        is what the credential may do with it now: a Personal key reads as its
        owner, judged on the owner's grants narrowed to the key's scopes, so it
        can approve only a hold it could release itself, and a key whose scopes
        do not reach `approvals:approve` sees every item view-only.
      operationId: listAttention
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: >-
            The previous page's `meta.nextCursor`. It is bound to the caller and
            the view; any other value is `400` `Invalid cursor`.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 25
          description: Items per page, 1 to 50 (default 25); anything else is `400`.
      responses:
        '200':
          description: One page of attention items
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/TrustAttentionPage'
                  meta:
                    allOf:
                      - allOf:
                          - $ref: '#/components/schemas/PlatformMeta'
                          - type: object
                            properties:
                              hasMore:
                                type: boolean
                                description: True when `nextCursor` continues the queue.
                              nextCursor:
                                type:
                                  - string
                                  - 'null'
                                description: >-
                                  Pass as `cursor` for the next page; null on
                                  the last page.
                              partial:
                                type: boolean
                                description: >-
                                  True whenever `data.coverage.status` is not
                                  `complete`: the page could not prove every
                                  source absent (see `data.coverage.reason`).
                            required:
                              - hasMore
                              - nextCursor
                              - partial
                      - $ref: '#/components/schemas/ListPageMeta'
                required:
                  - data
                  - meta
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
        '400':
          description: '`bad_request`: an invalid `limit` or `cursor`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse400'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
        '401':
          description: '`unauthorized`: missing or invalid credential'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse401'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
        '403':
          description: >-
            `forbidden`: the credential's grants, narrowed to its scopes, do not
            hold `audit:read` at its acting organization or at the deployment
            root; `error.requiredPermission` names it
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse403'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          description: '`internal_error`: unexpected error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse500'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
        '503':
          $ref: '#/components/responses/LimiterUnavailable'
      security:
        - BearerAuth: []
        - PlatformApiKey: []
        - PersonalKey: []
components:
  schemas:
    TrustAttentionPage:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TrustAttentionItem'
        coverage:
          type: object
          properties:
            status:
              type: string
              enum:
                - complete
                - partial
                - unavailable
            observedAt:
              type: number
            snapshotAt:
              type: number
            examined:
              type: number
            eligible:
              type: number
            capped:
              type: boolean
            reason:
              type:
                - string
                - 'null'
          required:
            - status
            - observedAt
            - snapshotAt
            - examined
            - eligible
            - capped
            - reason
          additionalProperties: false
        counts:
          type: object
          properties:
            visible:
              type: number
            overdue:
              type: number
            viewOnly:
              type: number
            canDecide:
              type: number
            following:
              type: number
          required:
            - visible
            - overdue
            - viewOnly
            - canDecide
            - following
          additionalProperties: false
      required:
        - items
        - coverage
        - counts
      additionalProperties: false
      description: >-
        One page of attention items, ordered for action, with `coverage` (how
        much of the attention sources this page proved; anything but `complete`
        sets `meta.partial`) and `counts` over the page's items. Continue with
        `meta.nextCursor`.
    PlatformMeta:
      type: object
      properties:
        requestId:
          type: string
        hasMore:
          type: boolean
        nextCursor:
          type:
            - string
            - 'null'
        asOf:
          anyOf:
            - type: integer
            - type: 'null'
      required:
        - requestId
      additionalProperties: true
    ListPageMeta:
      type: object
      description: >-
        A list page's continuation. While `hasMore` is true, `nextCursor` is a
        string: pass it as `cursor` for the next page. `hasMore: false` ends the
        list; with `truncated: true`, more exist past what this list reads, and
        no cursor reaches them.
      properties:
        hasMore:
          type: boolean
        nextCursor:
          type:
            - string
            - 'null'
        truncated:
          type: boolean
          description: >-
            Present and true on a last page when the list holds more rows than
            this operation reads. Narrow the request with its filters to reach
            them.
      required:
        - hasMore
        - nextCursor
      anyOf:
        - properties:
            hasMore:
              const: false
        - properties:
            nextCursor:
              type: string
    ErrorResponse400:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - bad_request
                    - allowed_scopes_removed
    ErrorResponse401:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - unauthorized
    ErrorResponse403:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - forbidden
                    - permission_denied
                    - operator_stopped
    ErrorResponse500:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - internal_error
    TrustAttentionItem:
      type: object
      properties:
        key:
          type: string
        kind:
          type: string
          enum:
            - human_node
            - policy_hold
            - approval
            - agent_setup
        id:
          type: string
        title:
          type: string
        summary:
          type:
            - string
            - 'null'
        requestedAt:
          type: number
        deadlineAt:
          type:
            - number
            - 'null'
        overdue:
          type: boolean
        ownerLabel:
          type:
            - string
            - 'null'
        workflowRunId:
          type:
            - string
            - 'null'
        sessionId:
          type:
            - string
            - 'null'
        orgUnitId:
          type:
            - string
            - 'null'
        source:
          type:
            - string
            - 'null'
        reason:
          type:
            - string
            - 'null'
        href:
          type: string
        effect:
          type: string
          enum:
            - resume_workflow
            - retry_after_approval
            - review_target
            - unknown
        resolution:
          type: string
          enum:
            - operator_approval
            - assigned_approval
            - operator_human_node
            - assigned_human_node
            - view_only
        unavailableReason:
          type:
            - string
            - 'null'
        form:
          anyOf:
            - $ref: '#/components/schemas/HumanTaskFormV2'
            - type: 'null'
        grantDescriptor:
          anyOf:
            - type: object
              properties:
                targetOrgUnitId:
                  type: string
                targetOrgUnitCode:
                  type: string
                connectionTarget:
                  type: string
                subjects:
                  type: array
                  items:
                    type: object
                    properties:
                      kind:
                        type: string
                        enum:
                          - worker
                          - workflow
                          - workflow_version
                      id:
                        type: string
                    required:
                      - kind
                      - id
                    additionalProperties: false
              required:
                - targetOrgUnitId
                - subjects
              additionalProperties: false
            - type: 'null'
        state:
          type: string
          enum:
            - pending
            - approved
            - rejected
            - resolved
            - expired
        subject:
          anyOf:
            - type: object
              properties:
                kind:
                  type: string
                  enum:
                    - procedure_build
                    - workflow_draft
                    - workflow_run
                    - agent_tool
                    - other
                label:
                  type: string
                href:
                  type:
                    - string
                    - 'null'
                requesterLabel:
                  type:
                    - string
                    - 'null'
                position:
                  anyOf:
                    - type: object
                      properties:
                        index:
                          type: number
                        total:
                          type: number
                      required:
                        - index
                        - total
                      additionalProperties: false
                    - type: 'null'
              required:
                - kind
                - label
                - href
                - requesterLabel
                - position
              additionalProperties: false
            - type: 'null'
        effectDetail:
          anyOf:
            - type: object
              properties:
                toolId:
                  type:
                    - string
                    - 'null'
                riskLevel:
                  anyOf:
                    - type: string
                      enum:
                        - read
                        - write
                        - financial
                        - destructive
                    - type: 'null'
                writes:
                  type: boolean
                sendsOut:
                  type: boolean
                credentialUse:
                  type: boolean
                sensitiveData:
                  type: boolean
                egressHosts:
                  type: array
                  items:
                    type: string
                egressHostsOmitted:
                  type: number
                requiredPermissions:
                  type: array
                  items:
                    type: string
              required:
                - toolId
                - riskLevel
                - writes
                - sendsOut
                - credentialUse
                - sensitiveData
                - egressHosts
                - egressHostsOmitted
                - requiredPermissions
              additionalProperties: false
            - type: 'null'
        argsPreview:
          anyOf:
            - type: object
              properties:
                json:
                  type: string
                truncated:
                  type: boolean
                redactedPaths:
                  type: number
                egressHosts:
                  type: array
                  items:
                    type: string
              required:
                - json
                - truncated
                - redactedPaths
                - egressHosts
              additionalProperties: false
            - type: 'null'
        approvers:
          anyOf:
            - type: object
              properties:
                names:
                  type: array
                  items:
                    type: string
                count:
                  type: number
                overflow:
                  type: boolean
                includesMe:
                  type: boolean
              required:
                - names
                - count
                - overflow
                - includesMe
              additionalProperties: false
            - type: 'null'
        ability:
          type: object
          properties:
            canApprove:
              type: boolean
            approveDoor:
              anyOf:
                - type: string
                  enum:
                    - operator
                    - assigned
                - type: 'null'
            approveBlockedReason:
              type:
                - string
                - 'null'
            canReject:
              type: boolean
            rejectDoor:
              anyOf:
                - type: string
                  enum:
                    - operator
                    - assigned
                - type: 'null'
            rejectBlockedReason:
              type:
                - string
                - 'null'
            rejectConsequence:
              type:
                - string
                - 'null'
            approveIsSelfRelease:
              type: boolean
              const: true
          required:
            - canApprove
            - approveDoor
            - approveBlockedReason
            - canReject
            - rejectDoor
            - rejectBlockedReason
            - rejectConsequence
          additionalProperties: false
        decision:
          anyOf:
            - type: object
              properties:
                decidedAt:
                  type: number
                decidedBy:
                  type: string
                decidedByPerson:
                  type: boolean
                reason:
                  type:
                    - string
                    - 'null'
                outcome:
                  type: string
                  enum:
                    - build_resumed
                    - build_waiting
                    - build_failed
                    - build_stopped
                    - workflow_resumed
                    - workflow_failed
                    - retry_allowed
                    - rejected
                    - answered
                    - timed_out
                    - skipped
                    - unknown
                statusLine:
                  type: string
                href:
                  type:
                    - string
                    - 'null'
                remaining:
                  type:
                    - number
                    - 'null'
              required:
                - decidedAt
                - decidedBy
                - decidedByPerson
                - reason
                - outcome
                - statusLine
                - href
                - remaining
              additionalProperties: false
            - type: 'null'
        cancelReason:
          type: string
          enum:
            - due_date
            - declined
            - run_ended
            - superseded
            - withdrawn
      required:
        - key
        - kind
        - id
        - title
        - summary
        - requestedAt
        - deadlineAt
        - overdue
        - ownerLabel
        - workflowRunId
        - sessionId
        - orgUnitId
        - source
        - reason
        - href
        - effect
        - resolution
        - unavailableReason
        - form
        - grantDescriptor
        - state
        - subject
        - effectDetail
        - argsPreview
        - approvers
        - ability
        - decision
      additionalProperties: false
      description: >-
        One Trust Fabric attention item: a held call, an approval, a human
        workflow step or an agent setup request, what it does, who decides it,
        and how it was decided. `ability` is what this credential may do with
        the item now: a Personal key is judged on its owner's grants narrowed to
        the key's scopes, so it can approve only what it could release itself,
        and a key whose scopes do not reach `approvals:approve` sees every item
        view-only; a platform key or an External App always sees `canApprove`
        and `canReject` false.
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - forbidden
                - permission_denied
                - not_found
                - resource_missing
                - method_not_allowed
                - bad_request
                - unprocessable
                - conflict
                - invalid_state
                - gone
                - payment_required
                - idempotency_key_invalid
                - idempotency_key_in_flight
                - idempotency_key_reuse
                - idempotency_result_unavailable
                - idempotency_outcome_unknown
                - allowed_scopes_removed
                - governance_door_stopped
                - operator_stopped
                - payload_too_large
                - rate_limited
                - internal_error
            message:
              type: string
            docUrl:
              type: string
              format: uri
            reason:
              type: string
              enum:
                - requester_unavailable
                - invalid_body
                - form_invalid
                - form_secret_like
                - eligibility_invalid
                - due_out_of_range
                - no_candidates
                - org_unit_required
                - requester_open_cap
                - person_open_cap
                - rate_limited
                - role_giving_refused
            requiredPermission:
              type:
                - string
                - 'null'
            personRequired:
              type: boolean
            decisionId:
              type: string
            capHeadroom:
              type: object
              properties:
                remainingCents:
                  type: number
                capCents:
                  type: number
                consumedCents:
                  type: number
                estimateCents:
                  type: number
              required:
                - remainingCents
                - capCents
                - consumedCents
                - estimateCents
              additionalProperties: false
            details:
              type: array
              items:
                type: object
                properties:
                  path:
                    type: string
                  param:
                    type: string
                  message:
                    type: string
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - invalid_format
                      - too_small
                      - too_big
                      - unknown_field
                      - invalid_json
                      - invalid
                required:
                  - path
                  - param
                  - message
                  - code
                additionalProperties: false
              maxItems: 50
          required:
            - code
            - message
          additionalProperties: true
        meta:
          type: object
          properties:
            requestId:
              type: string
            hasMore:
              type: boolean
            nextCursor:
              type:
                - string
                - 'null'
            asOf:
              anyOf:
                - type: integer
                - type: 'null'
          required:
            - requestId
          additionalProperties: true
      required:
        - error
        - meta
      additionalProperties: true
    HumanTaskFormV2:
      type: object
      properties:
        version:
          type: number
          const: 2
        schema:
          type: object
          properties:
            type:
              type: string
              const: object
            properties:
              type: object
              additionalProperties:
                anyOf:
                  - type: object
                    properties:
                      type:
                        type: string
                        const: string
                      title:
                        type: string
                      description:
                        type: string
                      format:
                        type: string
                        enum:
                          - email
                          - uri
                          - date
                          - date-time
                          - month
                      minLength:
                        type: number
                      maxLength:
                        type: number
                      pattern:
                        type: string
                      enum:
                        type: array
                        items:
                          type: string
                      oneOf:
                        type: array
                        items:
                          type: object
                          properties:
                            const:
                              type: string
                            title:
                              type: string
                          required:
                            - const
                            - title
                          additionalProperties: false
                      default:
                        type: string
                      xForgeMultiline:
                        type: boolean
                      xForgeFile:
                        type: boolean
                      xForgeJson:
                        anyOf:
                          - type: boolean
                            const: true
                          - type: string
                      xForgeRequiredWhen:
                        type: object
                        properties:
                          key:
                            type: string
                          equals:
                            type:
                              - string
                              - number
                              - boolean
                        required:
                          - key
                          - equals
                        additionalProperties: false
                    required:
                      - type
                      - title
                    additionalProperties: false
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - number
                          - integer
                      title:
                        type: string
                      description:
                        type: string
                      minimum:
                        type: number
                      maximum:
                        type: number
                      default:
                        type: number
                      xForgeRequiredWhen:
                        type: object
                        properties:
                          key:
                            type: string
                          equals:
                            type:
                              - string
                              - number
                              - boolean
                        required:
                          - key
                          - equals
                        additionalProperties: false
                    required:
                      - type
                      - title
                    additionalProperties: false
                  - type: object
                    properties:
                      type:
                        type: string
                        const: boolean
                      title:
                        type: string
                      description:
                        type: string
                      default:
                        type: boolean
                      xForgeRequiredWhen:
                        type: object
                        properties:
                          key:
                            type: string
                          equals:
                            type:
                              - string
                              - number
                              - boolean
                        required:
                          - key
                          - equals
                        additionalProperties: false
                    required:
                      - type
                      - title
                    additionalProperties: false
                  - type: object
                    properties:
                      type:
                        type: string
                        const: array
                      title:
                        type: string
                      description:
                        type: string
                      items:
                        anyOf:
                          - type: object
                            properties:
                              type:
                                type: string
                                const: string
                              enum:
                                type: array
                                items:
                                  type: string
                            required:
                              - type
                              - enum
                            additionalProperties: false
                          - type: object
                            properties:
                              anyOf:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    const:
                                      type: string
                                    title:
                                      type: string
                                  required:
                                    - const
                                    - title
                                  additionalProperties: false
                            required:
                              - anyOf
                            additionalProperties: false
                          - type: object
                            properties:
                              type:
                                type: string
                                enum:
                                  - string
                                  - number
                            required:
                              - type
                            additionalProperties: false
                      minItems:
                        type: number
                      maxItems:
                        type: number
                      xForgeFile:
                        type: boolean
                      xForgeList:
                        type: boolean
                      xForgeRequiredWhen:
                        type: object
                        properties:
                          key:
                            type: string
                          equals:
                            type:
                              - string
                              - number
                              - boolean
                        required:
                          - key
                          - equals
                        additionalProperties: false
                    required:
                      - type
                      - title
                      - items
                    additionalProperties: false
            required:
              type: array
              items:
                type: string
            xForgeOrder:
              type: array
              items:
                type: string
          required:
            - type
            - properties
            - required
            - xForgeOrder
          additionalProperties: false
        actions:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              label:
                type: string
              doneLabel:
                type: string
              style:
                type: string
                enum:
                  - primary
                  - danger
                  - default
              effect:
                type: string
                enum:
                  - permit
                  - stop
              requires:
                type: array
                items:
                  type: string
              assurance:
                type: string
                enum:
                  - none
                  - console_session
            required:
              - id
              - label
              - doneLabel
              - style
              - effect
              - requires
              - assurance
            additionalProperties: false
      required:
        - version
        - schema
        - actions
      additionalProperties: false
      description: >-
        A human task's v2 form: its fields (a JSON-Schema object with Forge
        `xForge*` hints, in `xForgeOrder`) and the actions that answer it. An
        action's `assurance` of `console_session` can be taken only in a Forge
        Console session. Read through a Personal key, a hold that sends outside
        Forge (external delivery) shows its approve as `console_session`.
  headers:
    RequestId:
      description: >-
        This answer's request id, the same as the envelope's `meta.requestId`:
        `req_` and 16 lowercase hex digits. Every response carries it. Quote it
        to support, or look the request up with `GET
        /api/v3/me/requests/{requestId}`.
      schema:
        type: string
    RateLimitLimit:
      description: >-
        The capacity of the bucket this request spent from: the most requests it
        admits at once. Sent on every response to a request that spent from its
        bucket, whatever its status: a 401 or 503 the operation answers after
        that spend carries it too. Absent on a refusal before the spend (a 401
        from authentication, a stopped `api_keys` door's 503
        `governance_door_stopped`, a credential's 403 at sign-in), on a route's
        own tighter 429, and on the limiter's own 503, which could not spend.
      schema:
        type: integer
        minimum: 0
    RateLimitRemaining:
      description: >-
        Requests left in the bucket this request spent from; 0 on a refusal.
        While the limiter is degraded (its fallback bucket admitted the
        request), an estimate.
      schema:
        type: integer
        minimum: 0
    RateLimitReset:
      description: Seconds until the bucket this request spent from is full again.
      schema:
        type: integer
        minimum: 0
    RetryAfter:
      description: >-
        Seconds to wait before sending the request again. Sent on a 429 and on a
        transient 503.
      schema:
        type: integer
        minimum: 1
  responses:
    RateLimited:
      description: >-
        `rate_limited`: this credential, or the organization as a whole, has
        spent the requests of this operation's class for now. Each credential
        has three buckets: `read` (GET, HEAD), `write` (every other method) and
        `expensive` (an operation that starts a model turn, a run, a billable VM
        or a bulk job); each operation names its class in `x-forge-rate-limit`
        and spends from that bucket only. Every credential's requests also spend
        from the organization ceiling, one bucket per class at ten times a
        credential's limit, shared by every credential of the deployment; the
        message names which one refused. Wait `Retry-After` seconds, then retry.
        Every authenticated response carries the `RateLimit-*` headers for the
        bucket it spent from, so a client can slow down before it is refused;
        `GET /api/v2/me/limits` answers all three buckets and the ceiling.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    LimiterUnavailable:
      description: >-
        `internal_error`: The server could not complete the request. Wait for
        `Retry-After`, then retry; resend a write only with the same
        `Idempotency-Key`. Forge answers it when its rate limiter is briefly
        unavailable (a read or write request falls back to a second bucket
        before it is refused; an `expensive` request is refused at once), or
        when a transient runtime fault stops the request.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        An External App: the JWT it obtains from `POST /oauth/token` with OAuth2
        client_credentials. Pass as `Authorization: Bearer <jwt>`. An app's
        static companion key also authenticates as the app, but is deprecated
        and is not protected by `Idempotency-Key`.
    PlatformApiKey:
      type: http
      scheme: bearer
      description: >-
        A platform API key, created in the Console under Developers. Pass as
        `Authorization: Bearer <key>`. It acts as itself, under its role grants
        narrowed by its scopes.
    PersonalKey:
      type: http
      scheme: bearer
      description: >-
        A Personal key (`fmcp_…`), bound to the person who created it, or an
        interactive MCP sign-in that resolves to one. Pass as `Authorization:
        Bearer <key>`. It acts for that person, under their role grants narrowed
        by its scopes; an operation that acts for a person admits only this
        kind.

````

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