> ## 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.

# Get a human task

> Get a human task. Requires a Personal key and permission `approvals:read`.

{/* 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

Reads one human task as the Personal key's owner sees it in the Forge Console: its prompt and v2
form with the actions that answer it, what was decided (`actionTaken`, `output`, `completionReason`)
or why it was canceled, and what the owner may do (`claimable`, `canTakeOver`).

## Who sees a task

The owner sees a task that asks them (`isCandidate`), one they watch, or one they asked for. An owner
who holds `approvals:approve` at the task's home also sees a hold or a workflow step they may take
over (`canTakeOver`, with its `reassignRef`) — but only through a key whose scopes reach
`approvals:approve`: a key carrying `approvals:read` alone never reports take-over. A review queue's
group task asks everyone who holds the queue's permission at the platform scope now, through the key's
scopes; the owner may take over its claim when they also hold `approvals:approve` at the platform scope,
and its `reassignRef` is `{ "kind": "human_task", "id": <task id> }`. A task the owner
may not see, a missing task and a malformed id all answer the same `404`.

A platform key or an External App gets `403` with `error.personRequired: true`. See
[Person-relative reads](https://docs.gloo.com/forge/reference/http-api/governance#person-relative-reads).

## Parameters

| Parameter | Required | Meaning |
| - | - | - |
| `id` | Yes | The human task id (`humanTaskId` on a My Work item). |

## Example

```bash
curl "$FORGE_BASE/api/v2/governance/getHumanTask?id=hir_456" \
  -H "Authorization: Bearer $FORGE_PERSONAL_KEY"
```

The response is `{ "data": { "humanTask": { … } }, "meta": { "requestId": "…" } }`; `humanTask`
follows the `HumanTaskView` schema. The MCP tool `forge_get_human_task` returns the same `data` and
`meta`.


## OpenAPI

````yaml /forge/reference/openapi-v3.json get /api/v3/governance-human-tasks/{humanTaskId}
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-human-tasks/{humanTaskId}:
    get:
      tags:
        - Governance
      summary: Get a human task
      description: >-
        Requires permission `approvals:read`.


        Reads one human task the Personal key's owner may see: one it asks them,
        one they watch, one they asked, or, for an owner who holds
        `approvals:approve` at its home through a key whose scopes reach it, a
        hold or a workflow step they may take over. Call it with a Personal key:
        it reads as the key's owner, the person who created it, never as anyone
        the request names. A platform key or an External App has no work of its
        own and is refused with `403` and `error.personRequired: true`. Anything
        this read says the owner may do is judged on the owner's grants narrowed
        to the key's scopes. A task the owner may not see, and a missing or
        malformed id, answer the same `404`.
      operationId: getHumanTask
      parameters:
        - name: humanTaskId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
          description: The human task id (`humanTaskId` on a My Work item).
      responses:
        '200':
          description: The task
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      humanTask:
                        $ref: '#/components/schemas/HumanTaskView'
                    required:
                      - humanTask
                    additionalProperties: false
                  meta:
                    $ref: '#/components/schemas/PlatformMeta'
                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'
        '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 is not a Personal key
            (`error.personRequired: true`, no grant remedies it), or the owner's
            grants narrowed to the key's scopes do not hold `approvals:read`
            (`error.requiredPermission`)
          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'
        '404':
          description: '`resource_missing`: no such task, or not one the owner may see'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse404'
          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:
        - PersonalKey: []
components:
  schemas:
    HumanTaskView:
      type: object
      properties:
        humanTaskId:
          type: string
        humanTaskKind:
          type: string
          enum:
            - trust_fabric_hold
            - workflow_human_node
            - agent_question
            - architect_plan
            - synthesis_confirmation
            - agent_setup
            - synthesis_review
            - procedure_review
            - judge_admission
            - curator_recommendation
            - foreman_approval
            - external_app_request
        state:
          type: string
          enum:
            - created
            - completed
            - canceled
        prompt:
          $ref: '#/components/schemas/HumanTaskPromptV2'
        form:
          anyOf:
            - $ref: '#/components/schemas/HumanTaskFormV2'
            - type: 'null'
        actionTaken:
          type: string
        output:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: number
              - type: boolean
              - type: 'null'
              - type: array
                items:
                  type: string
        completionReason:
          type: string
        cancelReason:
          type: string
          enum:
            - due_date
            - declined
            - run_ended
            - superseded
            - withdrawn
        dueAt:
          type:
            - number
            - 'null'
        isCandidate:
          type: boolean
        claimable:
          type: boolean
        canTakeOver:
          type: boolean
        reassignRef:
          anyOf:
            - anyOf:
                - type: object
                  properties:
                    kind:
                      type: string
                      const: approval
                    id:
                      type: string
                  required:
                    - kind
                    - id
                  additionalProperties: false
                - type: object
                  properties:
                    kind:
                      type: string
                      const: human_node
                    id:
                      type: string
                  required:
                    - kind
                    - id
                  additionalProperties: false
                - type: object
                  properties:
                    kind:
                      type: string
                      const: human_task
                    id:
                      type: string
                  required:
                    - kind
                    - id
                  additionalProperties: false
            - type: 'null'
        assignee:
          type: string
        candidateCount:
          type: number
        consoleUrl:
          type:
            - string
            - 'null'
      required:
        - humanTaskId
        - humanTaskKind
        - state
        - prompt
        - form
        - dueAt
        - isCandidate
        - claimable
        - canTakeOver
        - reassignRef
        - candidateCount
        - consoleUrl
      additionalProperties: false
      description: >-
        One human task as the Personal key's owner sees it: its prompt and v2
        form, what was decided (`actionTaken`, `output`, `completionReason`) or
        why it was canceled, and what the owner may do. `canTakeOver` and
        `reassignRef` are set only for an owner who holds `approvals:approve` at
        the task's home through a key whose scopes reach it; `consoleUrl` opens
        the task in the Forge Console.
    PlatformMeta:
      type: object
      properties:
        requestId:
          type: string
        hasMore:
          type: boolean
        nextCursor:
          type:
            - string
            - 'null'
        asOf:
          anyOf:
            - type: integer
            - type: 'null'
      required:
        - requestId
      additionalProperties: true
    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
    ErrorResponse404:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - resource_missing
    ErrorResponse500:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - internal_error
    HumanTaskPromptV2:
      type: object
      properties:
        version:
          type: number
          const: 2
        title:
          type: string
        summary:
          type: string
        detail:
          type: string
        metadata:
          type: object
          properties:
            decisionPacket:
              type: object
              properties:
                schemaVersion:
                  type: string
                  const: v1
                title:
                  type: string
                question:
                  type: string
                summary:
                  type: string
                recommendation:
                  type: object
                  properties:
                    decision:
                      type: string
                      enum:
                        - approve
                        - reject
                    rationale:
                      type: string
                  required:
                    - decision
                    - rationale
                  additionalProperties: false
                impact:
                  type: array
                  items:
                    type: object
                    properties:
                      label:
                        type: string
                      value:
                        type: string
                      tone:
                        type: string
                        enum:
                          - neutral
                          - warning
                          - danger
                    required:
                      - label
                      - value
                    additionalProperties: false
                exceptions:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                      label:
                        type: string
                      severity:
                        type: string
                        enum:
                          - info
                          - warning
                          - material
                      amount:
                        type: string
                      affectedEntities:
                        type: array
                        items:
                          type: string
                      summary:
                        type: string
                      evidence:
                        type: array
                        items:
                          anyOf:
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  const: step_output
                                stepId:
                                  type: string
                                field:
                                  type: string
                                label:
                                  type: string
                              required:
                                - kind
                                - stepId
                                - field
                              additionalProperties: false
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  const: approval
                                approvalId:
                                  type: string
                                label:
                                  type: string
                              required:
                                - kind
                                - approvalId
                              additionalProperties: false
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  const: file
                                fileId:
                                  type: string
                                label:
                                  type: string
                              required:
                                - kind
                                - fileId
                              additionalProperties: false
                    required:
                      - key
                      - label
                      - severity
                      - summary
                      - evidence
                    additionalProperties: false
                primaryArtifactFileId:
                  type: string
                approveEffect:
                  type: string
                rejectEffect:
                  type: string
              required:
                - schemaVersion
                - title
                - question
                - summary
                - approveEffect
                - rejectEffect
              additionalProperties: false
            agentRecommendation:
              type: object
              properties:
                summary:
                  type: string
                confidence:
                  type: number
                recommendation:
                  type: string
              required:
                - summary
                - confidence
                - recommendation
              additionalProperties: false
            impactPreview:
              type: object
              properties:
                downstreamCount:
                  type: number
                estCost:
                  type: number
                estDurationSec:
                  type: number
                riskFlags:
                  type: array
                  items:
                    type: string
              required:
                - downstreamCount
              additionalProperties: false
            nodePosition:
              type: object
              properties:
                index:
                  type: number
                total:
                  type: number
              required:
                - index
                - total
              additionalProperties: false
            assigneeSlackUserId:
              type: string
            workflowName:
              type: string
            vendorName:
              type: string
            stepId:
              type: string
            nodeName:
              type: string
            runId:
              type: string
            nodeId:
              type: string
            runStartedAtMs:
              type: number
            runTotalCostUsd:
              type: number
            runTriggeredBySlackUserId:
              type: string
            runTriggeredByDisplay:
              type: string
            timeoutAtMs:
              type: number
            resolvedInputs:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  type:
                    type: string
                  description:
                    type: string
                  value: {}
                  display:
                    type: string
                  files:
                    type: array
                    items:
                      type: object
                      properties:
                        fileId:
                          type: string
                        filename:
                          type: string
                        mimeType:
                          type: string
                        sizeBytes:
                          type: number
                      required:
                        - fileId
                        - filename
                      additionalProperties: false
                required:
                  - key
                  - type
                  - display
                additionalProperties: false
            agentSetup:
              type: object
              properties:
                agentId:
                  type: string
                agentName:
                  type: string
                checkIds:
                  type: array
                  items:
                    type: string
                    enum:
                      - worker_seated
                      - position_has_job
                      - owner_traceable
                      - access_floor
                      - owner_present
                      - owner_review_current
                      - identity_attested
                note:
                  type: string
                requestedByPersonId:
                  type: string
              required:
                - agentId
                - agentName
                - checkIds
              additionalProperties: false
            argsPreview:
              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
            holdContext:
              type: object
              properties:
                externalDelivery:
                  type: boolean
              required:
                - externalDelivery
              additionalProperties: false
            nodeContext:
              type: object
              properties:
                decisionPacket:
                  type: boolean
              required:
                - decisionPacket
              additionalProperties: false
            requestedByApp:
              type: object
              properties:
                via:
                  type: string
                  enum:
                    - external_app
                    - platform_key
                name:
                  type:
                    - string
                    - 'null'
              required:
                - via
                - name
              additionalProperties: false
          additionalProperties: false
      required:
        - version
        - title
        - summary
      additionalProperties: false
      description: >-
        A human task's v2 prompt: its title, summary and optional detail, and
        the context it was asked in (`metadata`). A resolved input's `value` is
        open JSON.
    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`.
    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
  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.