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

# Dispatch a workflow run

> Launch the active published version of a workflow by name or by id, or one of its published versions by id, and receive the run's durable identity. Requires permission `workflows:use`, plus `files:read` when an input references a staged file.

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

Dispatch launches the **active published version** of an existing workflow, unless a launch by `workflowId` names one of its published versions with `versionId`. The response tells you which version ran.

## Choose the workflow

Send exactly one of:

* `name` — the workflow's name, optionally with `factoryId` to scope the lookup to a factory.
* `workflowId` — the `id` from [List workflows](https://docs.gloo.com/forge/reference/http-api/workflows/list.md). `factoryId` is not accepted with `workflowId`.

With `workflowId` only, `versionId` runs that published version (active or superseded) instead of the active one; read its inputs with [getInputSchema](https://docs.gloo.com/forge/reference/http-api/workflows/getInputSchema.md) and the same `versionId`. A version that is not the workflow's answers `404`. `versionId` is not accepted with `name`.

Sending both, or neither, answers `400 bad_request` with `Provide exactly one of name or workflowId`.

## Response

A launch answers `200` with the run's durable identity, in this order:

| Field | Meaning |
| - | - |
| `runId` | The new run. Read it with [Get a run](https://docs.gloo.com/forge/reference/http-api/runs/get.md). |
| `convexWorkflowId` | The run's engine instance id. It is not a workflow id. |
| `workflowId` | The workflow that launched. |
| `versionId` | The exact published version that launched, or `null` if none was reported. |

```json
{
  "data": {
    "runId": "k57a2…",
    "convexWorkflowId": "k97f1…",
    "workflowId": "k12c9…",
    "versionId": "k33d0…"
  },
  "meta": { "requestId": "…" }
}
```

## Send an Idempotency-Key with every launch

Dispatch is a mutating operation, so it accepts an [`Idempotency-Key`](https://docs.gloo.com/forge/reference/idempotency) header. Send one per logical launch: a retry under the same key never starts a second run. The retry returns the original response, with the same four ids, when the caller still holds `workflows:use` **and** `runs:read` and may currently read the original run at its workflow's home and companies (see [Workflow dispatch replay](https://docs.gloo.com/forge/reference/idempotency.md#workflow-dispatch-replay)). Otherwise it answers `403` for a missing permission or `409` `idempotency_result_unavailable`: the dispatch completed, so reconcile authorized run state rather than dispatching again under a new key. The header is optional, but a launch sent without one has no retry protection. A retry of a dispatch recorded before 2026-09-30 replays that dispatch's original response, which carries only `runId` and `convexWorkflowId`; such a replay stays possible for up to 24 hours after the change.

```bash
curl -X POST "$FORGE_BASE/api/v2/workflows/dispatch" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f9c2e18-5a4d-4b7e-9c11-8e2f6a0d4b53" \
  -d '{ "workflowId": "k12c9…", "runtimeArgs": { "period": "2026-09" } }'
```

## File inputs

A `file` or `file[]` input takes the `fileId` of a file you staged with [`POST /api/v2/files`](https://docs.gloo.com/forge/reference/http-api/files#uploading-a-file):

1. Upload the file and keep the returned `fileId`.
2. Put that `fileId` in the input slot of `runtimeArgs`, for example `{ "report": "files_7d0c…" }`.

A launch whose `runtimeArgs` contain any platform file id also needs `files:read`; without it the answer is `403` with `requiredPermission: "files:read"`. An inline-only launch does not.

You may pass exactly the uploads you could download through [`GET /api/v2/files/content`](https://docs.gloo.com/forge/reference/http-api/files#downloading-a-file): the file must be bound to your credential's org tree (the org unit an upload through the same credential is bound to), and your credential must hold `files:read` at every company on the file. Isolation is per org tree, not per uploader. Anything else answers `422` with `Workflow input "<input>" is not an available file`, the same message whether the file does not exist, belongs to another org tree, is only a run output, or sits at a company you cannot read. A raw storage id is refused the same way. A run's output file cannot be passed straight into another run, even when you may download it: download it and upload it again through `POST /api/v2/files`.

## Errors

| Status | When |
| - | - |
| `400 bad_request` | Malformed JSON, not exactly one of `name` / `workflowId`, `factoryId` with `workflowId`, `versionId` with `name`, or a malformed `callback` or `customerId`. |
| `403 permission_denied` | The credential lacks `workflows:use`, or `files:read` when an input references a platform file. |
| `404 resource_missing` | `Workflow not found`: no such workflow, a malformed `workflowId`, or a workflow you may not launch. These are indistinguishable. A `versionId` that is not one of the workflow's published versions also answers `404`. |
| `422 unprocessable` | The input does not satisfy the workflow's input contract (a missing, undeclared or mistyped input, or a file input that is not an available file), or a `callback` the platform refuses. The message names the problem. |
| `503 internal_error` | The workflow is not ready to run; its owner must fix its configuration. |


## OpenAPI

````yaml /forge/reference/openapi-v3.json post /api/v3/workflows/dispatch
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/workflows/dispatch:
    post:
      tags:
        - Workflows
      summary: Dispatch a workflow run
      description: >-
        Requires permission `workflows:use`.


        Launch the active published version of an existing workflow, named by
        exactly one of `name` or `workflowId` (with `workflowId`, `versionId`
        runs one of its published versions instead; another workflow's version
        answers 404), and receive the run's durable identity: the run, its
        engine instance, the workflow and the exact version launched. Send an
        `Idempotency-Key` header on every launch: a same-key retry replays the
        original identity (to a caller who may currently read that run) instead
        of starting a second run. A file input takes a `fileId` staged through
        `POST /api/v2/files`; the caller needs `files:read`, and may reference
        only uploads it could download through `GET /api/v2/files/content` (not
        run outputs).
      operationId: dispatchWorkflow
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  description: >-
                    Kebab-case workflow name to dispatch. Provide exactly one of
                    `name` or `workflowId`.
                factoryId:
                  type: string
                  minLength: 1
                  description: >-
                    Optional factory scope for a launch by `name`; not accepted
                    with `workflowId`.
                workflowId:
                  type: string
                  minLength: 1
                  description: >-
                    Workflow id from `GET /api/v2/workflows/list`. Provide
                    exactly one of `name` or `workflowId`.
                versionId:
                  type: string
                  minLength: 1
                  description: >-
                    Optional, with `workflowId` only: run this published version
                    (active or superseded) instead of the active one. A version
                    that is not the workflow's answers 404.
                runtimeArgs:
                  type: object
                  description: >-
                    Workflow input arguments matching the workflow's input
                    contract. A `file` or `file[]` input takes `fileId` values
                    from `POST /api/v2/files`.
                  additionalProperties: true
                callback:
                  type: object
                  description: >-
                    Register a one-shot completion callback. When the run
                    reaches a terminal state Forge sends exactly one signed POST
                    to `url` carrying the v2 event envelope —
                    `workflow.completed` for a completed run, `workflow.failed`
                    otherwise (cancelled included; the exact status is on
                    `data.status`). Verify it with `X-Forge-Signature-V2`
                    against the calling app's callback signing secret. External
                    Application callers only.
                  properties:
                    url:
                      type: string
                      format: uri
                      description: >-
                        HTTPS destination. Validated at request time: HTTPS
                        only, no private / loopback / link-local hosts.
                  required:
                    - url
                  additionalProperties: false
                customerId:
                  type: string
                  description: >-
                    Optional. Attribute this run to one of your end customers,
                    so its token spend rolls up under that customer (readable
                    via `GET /api/v2/cost/customer`).


                    Ownership-fenced: a `customerId` that does not exist, or
                    exists but is not linked to the calling application, is
                    rejected with `400` — a caller cannot attribute a run to
                    another tenant's customer. Requires an External-Application
                    credential; a platform-key caller passing `customerId` also
                    gets `400`. Obtain one from `POST
                    /api/v2/external/customers/findOrCreate`.
              oneOf:
                - required:
                    - name
                  not:
                    required:
                      - versionId
                - required:
                    - workflowId
                  not:
                    required:
                      - factoryId
              additionalProperties: false
      responses:
        '200':
          description: >-
            Run launched. A same-key retry of a dispatch recorded before the
            four-field identity (2026-09-30) replays its original `{ runId,
            convexWorkflowId }` result.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    oneOf:
                      - $ref: '#/components/schemas/WorkflowDispatchResult'
                      - $ref: '#/components/schemas/WorkflowDispatchLegacyResult'
                  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'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse400Keyed'
          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
          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 lacks `workflows:use`, or `files:read`
            when `runtimeArgs` references a platform file.
          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: >-
            Workflow not found: no such workflow, a malformed `workflowId`, or
            one the caller may not launch. The three are indistinguishable.
          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'
        '409':
          description: >-
            A request under this Idempotency-Key is still running, its stored
            result cannot be returned, or its outcome is unknown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse409Keyed'
          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'
        '422':
          description: >-
            The input does not satisfy the workflow's input contract (missing,
            undeclared or mistyped input, or a file input that is not an
            available file), `callback.url` failed the HTTPS/SSRF validator, or
            the caller has no owning External Application to sign the delivery
            with.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse422Keyed'
          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'
        '503':
          $ref: '#/components/responses/LimiterUnavailable'
      security:
        - BearerAuth: []
        - PlatformApiKey: []
        - PersonalKey: []
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        1–255 printable ASCII characters (`0x21`–`0x7E`, no spaces), scoped to
        the calling credential. A repeat with the same key and request never
        runs the write again, a 5xx included: once the operation's permissions
        pass again it answers the identical status and body of the first
        response (`Idempotent-Replayed: true`, also sent as
        `Idempotency-Replayed: true`), unless the operation's own replay policy
        withholds it; a first response that was not stored (over 32 KiB, or
        carrying a one-time secret) answers its first status with only `data.id`
        (`Idempotency-Replay-Disclosure: id-only`) when it named one; otherwise
        `409` `idempotency_result_unavailable`; a repeat while the first is
        still running is `409` `idempotency_key_in_flight`, and the same key
        with a different request is `422` `idempotency_key_reuse`. Honoured for
        External App JWTs and platform and Personal keys; an External App's
        static companion key is not protected.
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    WorkflowDispatchResult:
      type: object
      description: >-
        The durable identity of a launched run: the run, its engine instance,
        the workflow and the exact version launched. `versionId` is null only
        when no version is reported.
      properties:
        runId:
          type: string
          minLength: 1
        convexWorkflowId:
          type: string
          minLength: 1
        workflowId:
          type: string
          minLength: 1
        versionId:
          type:
            - string
            - 'null'
          minLength: 1
      required:
        - runId
        - convexWorkflowId
        - workflowId
        - versionId
      additionalProperties: false
    WorkflowDispatchLegacyResult:
      type: object
      description: >-
        A same-key replay of a dispatch recorded before the four-field identity
        (2026-09-30): its original run and engine ids.
      properties:
        runId:
          type: string
          minLength: 1
        convexWorkflowId:
          type: string
          minLength: 1
      required:
        - runId
        - convexWorkflowId
      additionalProperties: false
    PlatformMeta:
      type: object
      properties:
        requestId:
          type: string
        hasMore:
          type: boolean
        nextCursor:
          type:
            - string
            - 'null'
        asOf:
          anyOf:
            - type: integer
            - type: 'null'
      required:
        - requestId
      additionalProperties: true
    ErrorResponse400Keyed:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - bad_request
                    - allowed_scopes_removed
                    - idempotency_key_invalid
    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
    ErrorResponse409Keyed:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - conflict
                    - invalid_state
                    - idempotency_key_in_flight
                    - idempotency_result_unavailable
                    - idempotency_outcome_unknown
    ErrorResponse422Keyed:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - unprocessable
                    - idempotency_key_reuse
    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.