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

# Discover your current actor

> Self-discovery for any Platform API credential — the verified actor, its current narrowed permissions and the advisory prerequisites of each documented operation that requires a permission. Requires no permission.

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

Returns what **this request** carries: who the credential is, which org unit it acts within, the
permissions it holds after they are narrowed by its key or token scopes, where those permissions
come from, and what each
documented operation requires. Use it to tell a missing grant apart from a denial at a particular
resource before you call an operation.

## Authorization

`GET /api/v2/actor` requires **no permission**. Any Platform API credential can call it: a
platform API key, a person-bound MCP key, or an External Application access token. Every fact it
returns is about the caller.

The endpoint takes **no identifier**. There is no path segment, no query parameter and no body.
A request that sends any query parameter or a body is refused with `400` and code `bad_request`,
so there is no way to ask about another key, app or person. A Personal key's answer names the person it acts for, read from the key itself, never from the request.

A missing, revoked or expired credential receives the usual `401`, with no discovery data.

## Response

| Field | Meaning |
| - | - |
| `actor.kind` | `api_key` for a platform or Personal key, `external_app` for an External Application (including its deprecated companion key). |
| `actor.id` | The verified id of that key or application. |
| `actor.permissionsSource` | Present only as `owner`, for a [Personal key](https://docs.gloo.com/forge/console/settings/personal-keys.md): it holds no roles of its own and acts with its owner's current permissions, and `owner` names that person. Absent for every other credential, whose permissions are its own role grants. |
| `owner` | For a Personal key, the person and worker it acts for, as the Console shows that person their own identity: `personId`, `workerId` (their primary worker seat), `workerIds` (every active seat), `userId`, `name`, `email`, `workerType` and `status`. `null` for every other credential, and for an owner with no active worker seat. |
| `actingOrgUnitId` | The org unit the request acts within, or `null` for a user-owned External Application. |
| `grantedPermissions` | The permissions this request holds at its org unit, narrowed by its key or token scopes: the actor's own role-grant permissions, or for a Personal key its owner's. Sorted, no repeats. |
| `operations` | One entry per documented operation that requires a permission, sorted by method then path, plus the three scope-gated human-task writes described below. Operations that require no permission (`GET /api/v2/actor`, `GET /api/v2/me`, `GET /api/v2/me/limits`, `GET /api/v2/me/permissions`, `GET /api/v2/me/denials/{decisionId}`, `GET /api/v2/mcp/config`) are not listed. |

Each entry in `operations` has:

| Field | Meaning |
| - | - |
| `method`, `path` | The operation. |
| `requiredPermissions` | Every permission the operation requires. All are needed, not any one. |
| `permissionSatisfied` | `true` when `grantedPermissions` holds every required permission. For a scope-gated operation, `true` when the credential's scopes reach `approvals:approve`. |
| `personRequired` | `true` when the operation requires a permission this credential's kind can never hold, whatever roles it is given. An API key or External App may hold every catalog permission, so today it is `false` for every operation. |
| `resourceCheckRequired` | `true` when the operation acts on a target you choose (an id, a namespace, a customer, a workflow to dispatch). Holding the permission says nothing about access to that target: the operation decides it when you call it. |

`POST /api/v2/governance/actOnHumanTask`, `POST /api/v2/governance/completeHumanTask` and
`POST /api/v2/governance/attachHumanTaskOutputFile` are **scope-gated**: they require no role
permission, so their `requiredPermissions` is empty, but the credential's scopes must reach
`approvals:approve`.

> [!WARNING]
>
> `permissionSatisfied` is advisory. It does not mean the operation will succeed on a particular
> resource: the operation re-authenticates your credential and checks the target's current home,
> company and policy when you call it. `resourceCheckRequired: false` is not a resource authorization
> either. Do not cache this response as an authorization decision.

An operation with `personRequired: true` always reports `permissionSatisfied: false`: it needs a
permission this credential's kind can never hold. No operation decides an approval yet (a person
decides in Forge Console, Slack or email). To hand a held run to a person, read its status with
[`GET /api/v2/runs/getTrustStatus`](https://docs.gloo.com/forge/reference/http-api/runs/getTrustStatus) and give that
person its `handoff`.

The response never includes role ids, grant records, key material or raw token claims. Operations
under a path prefix and operations not yet in the OpenAPI document are not listed.

## Example

```bash
curl "$FORGE_BASE/api/v2/actor" \
  -H "Authorization: Bearer $FORGE_TOKEN"
```

```json
{
  "data": {
    "actor": { "kind": "external_app", "id": "externalApplications:k17..." },
    "owner": null,
    "actingOrgUnitId": "orgUnits:acme",
    "grantedPermissions": ["agents:read", "runs:read"],
    "operations": [
      {
        "method": "GET",
        "path": "/api/v2/agents/get",
        "requiredPermissions": ["agents:read"],
        "permissionSatisfied": true,
        "personRequired": false,
        "resourceCheckRequired": true
      },
      {
        "method": "POST",
        "path": "/api/v2/agents/create",
        "requiredPermissions": ["agents:write"],
        "permissionSatisfied": false,
        "personRequired": false,
        "resourceCheckRequired": false
      }
    ]
  },
  "meta": { "requestId": "req_8c1f..." }
}
```

The example shows two of the operations; a real response lists every documented operation that requires a permission.

MCP clients read it with the [`forge_get_current_actor`](https://docs.gloo.com/forge/reference/mcp-server#current-actor-1-every-group) tool: by default a summary with operation counts, one page of operations with `detail: "operations"`, and this response's data exactly with `detail: "full"`.

## Related

* [List your effective permissions](https://docs.gloo.com/forge/reference/http-api/actor/my-permissions.md) — the same permissions and operations, without the actor block
* [Explain one of your refusals](https://docs.gloo.com/forge/reference/http-api/actor/my-denials.md) — why a `403` refused you, by its `decisionId`
* [Permissions and scopes](https://docs.gloo.com/forge/reference/conventions.md#permissions-and-scopes) — how role grants and scopes combine
* [Get your own External Application record](https://docs.gloo.com/forge/reference/http-api/externalApps/me.md) — an app's own configuration


## OpenAPI

````yaml /forge/reference/openapi-v3.json get /api/v3/me/actor
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/me/actor:
    get:
      tags:
        - Actor
      summary: >-
        Describe the calling credential's current actor and operation
        prerequisites
      description: >-
        Requires no permission: Self-introspection: any Platform API credential
        reads only its own verified actor, its current narrowed permission names
        and the public prerequisites of documented operations; the request names
        no actor or resource and receives no resource eligibility verdict.


        Returns the verified actor reference of the credential making this
        request (a platform or Personal key as `api_key`, an External
        Application as `external_app`) and, for a Personal key only,
        `permissionsSource: "owner"`: the key holds no roles and acts with its
        owner's current permissions (absent for every other credential, which
        acts with its own role grants). For a Personal key, `owner` names the
        person and worker it acts for: the person id, the primary and every
        active worker seat, the user id, name, email, worker type and status, as
        the Console shows that person their own identity; it is `null` for every
        other credential, and for an owner with no active worker. It also
        returns the acting org unit, the permissions this request holds after
        those permissions are narrowed by its key or token scopes, and the
        required permissions of each documented operation that requires one, and
        of each scope-gated operation, which requires no role permission but
        only that the credential's own scopes reach the one catalog key its
        handler checks (its `requiredPermissions` is empty; other
        permission-free operations are not listed). `permissionSatisfied` is
        advisory: holding a permission does not prove access to a particular
        resource, and `resourceCheckRequired` marks operations that act on a
        target you choose; access to that target is decided when you call the
        operation. `personRequired: true` marks an operation that requires a
        permission this credential's kind can never hold; an eligible person
        must act in the Forge Console instead, so no role change can make it
        satisfiable. An API key or External App may hold every catalog
        permission, so it is `false` for every operation today. The request
        takes no query parameters and no body; the actor is determined solely by
        the credential. Role ids, grant rows, key material and raw token claims
        are never returned.
      operationId: getCurrentActor
      responses:
        '200':
          description: The calling credential's current actor
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      actor:
                        anyOf:
                          - type: object
                            properties:
                              kind:
                                type: string
                                const: api_key
                              id:
                                type: string
                                minLength: 1
                              permissionsSource:
                                type: string
                                const: owner
                            required:
                              - kind
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              kind:
                                type: string
                                const: external_app
                              id:
                                type: string
                                minLength: 1
                            required:
                              - kind
                              - id
                            additionalProperties: false
                      owner:
                        anyOf:
                          - type: object
                            properties:
                              personId:
                                type: string
                                minLength: 1
                              workerId:
                                type: string
                                minLength: 1
                              workerIds:
                                type: array
                                items:
                                  type: string
                                  minLength: 1
                              userId:
                                type:
                                  - string
                                  - 'null'
                              name:
                                type: string
                              email:
                                type:
                                  - string
                                  - 'null'
                              workerType:
                                type: string
                              status:
                                type: string
                            required:
                              - personId
                              - workerId
                              - workerIds
                              - userId
                              - name
                              - email
                              - workerType
                              - status
                            additionalProperties: false
                          - type: 'null'
                      actingOrgUnitId:
                        type:
                          - string
                          - 'null'
                      grantedPermissions:
                        type: array
                        items:
                          type: string
                      operations:
                        type: array
                        items:
                          type: object
                          properties:
                            method:
                              type: string
                              enum:
                                - GET
                                - POST
                                - PUT
                                - PATCH
                                - DELETE
                                - OPTIONS
                            path:
                              type: string
                              pattern: ^\/api\/v2\/
                            requiredPermissions:
                              type: array
                              items:
                                type: string
                            permissionSatisfied:
                              type: boolean
                            personRequired:
                              type: boolean
                            resourceCheckRequired:
                              type: boolean
                          required:
                            - method
                            - path
                            - requiredPermissions
                            - permissionSatisfied
                            - personRequired
                            - resourceCheckRequired
                          additionalProperties: false
                    required:
                      - actor
                      - owner
                      - actingOrgUnitId
                      - grantedPermissions
                      - operations
                    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'
        '400':
          description: A query parameter or request body was supplied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse400'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
        '401':
          description: Unauthorized
          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'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/LimiterUnavailable'
      security:
        - BearerAuth: []
        - PlatformApiKey: []
        - PersonalKey: []
components:
  schemas:
    PlatformMeta:
      type: object
      properties:
        requestId:
          type: string
        hasMore:
          type: boolean
        nextCursor:
          type:
            - string
            - 'null'
        asOf:
          anyOf:
            - type: integer
            - type: 'null'
      required:
        - requestId
      additionalProperties: true
    ErrorResponse400:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - bad_request
                    - allowed_scopes_removed
    ErrorResponse401:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - unauthorized
    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.