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

# List knowledge cases

> Page the knowledge cases a credential can read, filtered and sorted as the Console knowledge list. Requires knowledge: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

`GET /api/v2/knowledge/cases/list` lists the cases in the credential's readable namespaces, or in the one readable namespace it names, newest first by default. It needs `knowledge:read`. A source-restricted case is never returned, even to your own MCP key. See [Knowledge cases](https://docs.gloo.com/forge/reference/http-api/knowledge#knowledge-cases) for what a case carries and what it never carries.

| Query parameter | Meaning |
| - | - |
| `namespace` | One namespace in the credential's readable set, such as `company` or `team:<orgUnitId>`. Outside it: `403`. |
| `search` | A case-insensitive substring of the title, summary, key or source id, 1–500 characters. |
| `scopeType`, `contentType`, `sourceType` | Repeatable; the knowledge scope, content and source types. |
| `grade` | Repeatable: `provisional`, `proven`, `contested`, `retired`, or `ungraded` for an entry with none. |
| `artifactKind` | Repeatable: `lesson`, `policy`, `how_to`, `reference`, `faq`, `note`, or `unclassified` for a case with none. |
| `collectionId` | Only the artifacts filed in this subject collection, from [List subject collections](https://docs.gloo.com/forge/reference/http-api/knowledge/list-subject-collections.md). Records and artifacts waiting for review are never listed. A collection that is unknown, archived or out of reach: `404`. |
| `sort` | `newest` (default), `oldest` or `title`. |
| `cursor` | `meta.nextCursor` from the previous page. |
| `limit` | Candidate rows read for the page, 20–80, default 25. |

Each page reads up to `limit` candidate rows and returns those that match and are readable, so a page may hold fewer cases than `limit`, or none, while `meta.hasMore` is `true`. Follow `meta.nextCursor` until it is `null`. Any other parameter, a value outside its set, an empty or repeated single-valued parameter, or a cursor Forge cannot read answers `400 bad_request`. A title sort answers `400` while case titles are still being prepared after an upgrade.

An empty search page is not proof that a key is unused. Use [Get case by exact namespace and key](https://docs.gloo.com/forge/reference/http-api/knowledge/get-case.md) for deterministic SOP duplicate checks. A Personal MCP key can explicitly select one authorized `customer:<canonicalCustomerId>` namespace; omitting it never enumerates Customer partitions.

```bash
curl -G "$FORGE_BASE/api/v2/knowledge/cases/list" \
  -H "Authorization: Bearer $FORGE_API_KEY" \
  --data-urlencode "namespace=company" \
  --data-urlencode "grade=proven"
```


## OpenAPI

````yaml /forge/reference/openapi-v3.json get /api/v3/knowledge-cases
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/knowledge-cases:
    get:
      tags:
        - Knowledge
      summary: List knowledge cases
      description: >-
        Requires permission `knowledge:read`.


        Lists the cases in the caller's readable namespaces (or one named
        readable namespace), filtered and sorted as the Console knowledge list,
        newest first by default. Each page reads up to `limit` candidate rows
        and returns those that match and are readable, so a page may hold fewer
        rows than `limit`, or none, while `meta.hasMore` is true: follow
        `meta.nextCursor` until it is null. Rows of every `contentType` are
        listed, synchronized records (`record`) included; filter with
        `contentType`, and read a namespace's counts by content type and its
        record kinds with `scopes/get`. Source-restricted cases are never
        returned.
      operationId: listKnowledgeCases
      parameters:
        - name: namespace
          in: query
          required: false
          description: >-
            One readable knowledge namespace (`company`, `team:<orgUnitId>`, …).
            An unreadable namespace answers 403.
          schema:
            type: string
            minLength: 1
        - name: search
          in: query
          required: false
          description: >-
            A case-insensitive substring of the case's title, summary, key or
            source id (1–500 characters).
          schema:
            type: string
            minLength: 1
            maxLength: 500
        - name: scopeType
          in: query
          required: false
          description: >-
            Only cases in these scope types. Repeat the parameter for several
            values; any other value answers 400.
          schema:
            type: array
            items:
              type: string
              enum:
                - personal
                - team
                - department
                - company
                - global
                - factory
                - project
                - direct
                - group
                - system
                - agent
                - external_app
                - customer
                - organization
          style: form
          explode: true
        - name: contentType
          in: query
          required: false
          description: >-
            Only entries of these content types. Repeat the parameter for
            several values; any other value answers 400.
          schema:
            type: array
            items:
              type: string
              enum:
                - document
                - message
                - workflow_output
                - note
                - session_summary
                - file
                - moment
                - snippet
                - case
                - record
          style: form
          explode: true
        - name: sourceType
          in: query
          required: false
          description: >-
            Only entries from these sources. Repeat the parameter for several
            values; any other value answers 400.
          schema:
            type: array
            items:
              type: string
              enum:
                - upload
                - chat_save
                - auto_ingest
                - session_close
                - memory_promotion_agent
                - memory_promotion_human
                - memory_promotion_threshold
                - memory_promotion_compression
                - agent_record
                - external_sync
          style: form
          explode: true
        - name: grade
          in: query
          required: false
          description: >-
            Only cases with these grades; `ungraded` matches an entry with none.
            Repeat the parameter for several values; any other value answers
            400.
          schema:
            type: array
            items:
              type: string
              enum:
                - provisional
                - proven
                - contested
                - retired
                - ungraded
          style: form
          explode: true
        - name: artifactKind
          in: query
          required: false
          description: >-
            Only cases of these artifact kinds; `unclassified` matches a case
            with none. Repeat the parameter for several values; any other value
            answers 400.
          schema:
            type: array
            items:
              type: string
              enum:
                - lesson
                - policy
                - how_to
                - reference
                - faq
                - note
                - unclassified
          style: form
          explode: true
        - name: collectionId
          in: query
          required: false
          description: >-
            Only the artifacts filed in this subject collection (from
            `subjectCollections/list`); records and artifacts waiting for review
            are never listed. A collection that is unknown, archived or out of
            the caller's reach answers the same 404.
          schema:
            type: string
            minLength: 1
        - name: sort
          in: query
          required: false
          description: >-
            `newest` (default), `oldest` or `title`. A title sort answers 400
            while titles are still being prepared after an upgrade.
          schema:
            type: string
            enum:
              - newest
              - oldest
              - title
            default: newest
        - name: cursor
          in: query
          required: false
          description: >-
            The `meta.nextCursor` from the previous page; omit for the first
            page.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: Candidate rows read for this page, 20–80 (default 25).
          schema:
            type: integer
            minimum: 20
            maximum: 80
            default: 25
        - name: actingFor
          in: query
          required: false
          description: >-
            The orgUnitId of the one external organization this request acts for
            (listed by `GET /api/v2/knowledge/scopes/list` with `scopeType`
            `organization`). It needs `knowledge:read` (`knowledge:manage` for
            an edit) at that organization's own unit or at platform scope; a
            grant at Gloo's root does not reach it. Absent, the request reads
            Gloo's knowledge only and never an organization's. One organization
            per request. A refused `actingFor` answers 403; an admitted one is
            audited before the answer, and a read whose audit cannot be written
            answers 500.
          schema:
            type: string
            minLength: 1
            maxLength: 200
      responses:
        '200':
          description: Readable knowledge cases
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/KnowledgeCase'
                  meta:
                    allOf:
                      - allOf:
                          - $ref: '#/components/schemas/PlatformMeta'
                        description: >-
                          `hasMore` and `nextCursor` page the list; a page may
                          hold fewer rows than `limit`.
                      - $ref: '#/components/schemas/ListPageMeta'
                required:
                  - data
                  - meta
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
        '400':
          description: >-
            Bad request: an unknown, repeated or empty query parameter, a value
            outside its set, a `limit` outside 20–80, an unreadable cursor
            (`Invalid cursor`), a title sort while titles are being prepared, or
            `actingFor` with `collectionId`
          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'
        '403':
          description: >-
            Forbidden: `namespace` is outside the caller's readable namespaces,
            or `actingFor` is refused
          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`: `collectionId` names a subject collection that
            is unknown, archived or outside the caller's reach
          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`: the request failed (an embeddings or model
            provider error, for example). The body names only the `requestId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse500'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
        '503':
          $ref: '#/components/responses/LimiterUnavailable'
      security:
        - BearerAuth: []
        - PlatformApiKey: []
        - PersonalKey: []
components:
  schemas:
    KnowledgeCase:
      type: object
      properties:
        id:
          type: string
          minLength: 1
        namespace:
          type: string
        scopeType:
          type: string
          enum:
            - personal
            - team
            - department
            - company
            - global
            - factory
            - project
            - direct
            - group
            - system
            - agent
            - external_app
            - customer
            - organization
        contentType:
          type: string
          enum:
            - document
            - message
            - workflow_output
            - note
            - session_summary
            - file
            - moment
            - snippet
            - case
            - record
        sourceType:
          type: string
          enum:
            - upload
            - chat_save
            - auto_ingest
            - session_close
            - memory_promotion_agent
            - memory_promotion_human
            - memory_promotion_threshold
            - memory_promotion_compression
            - agent_record
            - external_sync
        artifactKind:
          anyOf:
            - type: string
              enum:
                - lesson
                - policy
                - how_to
                - reference
                - faq
                - note
            - type: 'null'
        title:
          type:
            - string
            - 'null'
        caseKey:
          type:
            - string
            - 'null'
        grade:
          anyOf:
            - type: string
              enum:
                - provisional
                - proven
                - contested
                - retired
            - type: 'null'
        tags:
          type: array
          items:
            type: string
        createdAt:
          type: number
        updatedAt:
          type:
            - number
            - 'null'
        version:
          type: integer
          exclusiveMinimum: 0
        successCount:
          type: integer
          minimum: 0
        failureCount:
          type: integer
          minimum: 0
        ownerWorkerId:
          type:
            - string
            - 'null'
        verifyEveryDays:
          anyOf:
            - type: integer
              exclusiveMinimum: 0
            - type: 'null'
        verifiedAt:
          type:
            - number
            - 'null'
        verificationDueAt:
          type:
            - number
            - 'null'
        knowledgeSourceId:
          type:
            - string
            - 'null'
        sourceUrl:
          type:
            - string
            - 'null'
        runId:
          type:
            - string
            - 'null'
        nodeId:
          type:
            - string
            - 'null'
        agentId:
          type:
            - string
            - 'null'
      required:
        - id
        - namespace
        - scopeType
        - contentType
        - sourceType
        - artifactKind
        - title
        - caseKey
        - grade
        - tags
        - createdAt
        - updatedAt
        - version
        - successCount
        - failureCount
        - ownerWorkerId
        - verifyEveryDays
        - verifiedAt
        - verificationDueAt
        - knowledgeSourceId
        - sourceUrl
        - runId
        - nodeId
        - agentId
      additionalProperties: false
      description: >-
        One knowledge case in a namespace the caller may read. `version` is the
        case's text version (1 before its first rewrite): name it as
        `expectedVersion` to edit the case. `verificationDueAt` is when its
        opt-in verification interval falls due (null without one). An absent
        value is null; a counter never written is 0. Never carries who ingested,
        graded, verified, deleted or archived the case, its evidence or evidence
        notes, its RAG id, storage, content hash, source access, owning External
        App or home org unit.
    PlatformMeta:
      type: object
      properties:
        requestId:
          type: string
        hasMore:
          type: boolean
        nextCursor:
          type:
            - string
            - 'null'
        asOf:
          anyOf:
            - type: integer
            - type: 'null'
      required:
        - requestId
      additionalProperties: true
    ListPageMeta:
      type: object
      description: >-
        A list page's continuation. While `hasMore` is true, `nextCursor` is a
        string: pass it as `cursor` for the next page. `hasMore: false` ends the
        list; with `truncated: true`, more exist past what this list reads, and
        no cursor reaches them.
      properties:
        hasMore:
          type: boolean
        nextCursor:
          type:
            - string
            - 'null'
        truncated:
          type: boolean
          description: >-
            Present and true on a last page when the list holds more rows than
            this operation reads. Narrow the request with its filters to reach
            them.
      required:
        - hasMore
        - nextCursor
      anyOf:
        - properties:
            hasMore:
              const: false
        - properties:
            nextCursor:
              type: string
    ErrorResponse400:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - bad_request
                    - allowed_scopes_removed
    ErrorResponse401:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - unauthorized
    ErrorResponse403:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - forbidden
                    - permission_denied
                    - operator_stopped
    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
    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.