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

# Get knowledge health

> What is broken in the knowledge you can read, and how far behind it is. Requires permission `knowledge:read`.

Returns a `KnowledgeHealth`: the same health projection the Console's Knowledge › Health page shows, over the namespaces the credential can read (or the one `namespace` selects), read as no person. Each section names its `scope`: `readable` sections cover only those namespaces, and `deployment` sections are deployment-wide. Source configuration, cursors and case keys are never returned, a source's last error is redacted, and the re-embed run's error text is withheld. A `namespace` outside the readable set answers `403`; an unknown, repeated or empty query parameter answers `400`. See [Knowledge health](https://docs.gloo.com/forge/reference/http-api/knowledge#knowledge-health).


## OpenAPI

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


        What is broken in the knowledge the caller can read, and how far behind
        it is: stuck pending entries, failing and overdue sources, failing and
        quarantined source items, embedding staleness, open review items, the
        latest re-embed run's progress, the integrity audit, the knowledge cron
        runs and the learning settings in force. Each section names its scope:
        `readable` sections cover only the caller's readable namespaces (or the
        one `namespace` selects), read as no person, so an entry restricted to
        named people is left out and such a failing item is `restricted` with no
        error; `deployment` sections are deployment-wide. Source configuration,
        cursors and case keys are never returned, a source's last error is
        redacted, and the re-embed run's error text is withheld (`hasError`).
        Every list is bounded and says `truncated` when the bounded read stopped
        early. Read-only: settings are changed in the Console.
      operationId: getKnowledgeHealth
      parameters:
        - name: namespace
          in: query
          required: false
          description: >-
            One knowledge namespace to report on (for example `company` or
            `external_app:<appId>`). It must be in the caller's readable set.
            Omitted: every readable namespace.
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: Knowledge health
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/KnowledgeHealth'
                  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: an unknown, repeated or empty query parameter'
          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: the credential lacks the required scope, or `namespace`
            is outside the caller's readable namespaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse403'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          description: >-
            `internal_error`: 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:
    KnowledgeHealth:
      type: object
      properties:
        pending:
          type: object
          properties:
            scope:
              type: string
              const: readable
            entries:
              type: array
              items:
                type: object
                properties:
                  entryId:
                    type: string
                    minLength: 1
                  namespace:
                    type: string
                  createdAt:
                    type: number
                required:
                  - entryId
                  - namespace
                  - createdAt
                additionalProperties: false
            total:
              type: integer
              minimum: 0
            truncated:
              type: boolean
          required:
            - scope
            - entries
            - total
            - truncated
          additionalProperties: false
        sources:
          type: object
          properties:
            scope:
              type: string
              const: readable
            items:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                  name:
                    type: string
                  providerKey:
                    type: string
                  namespace:
                    type: string
                  targetScopeType:
                    type: string
                  mode:
                    type: string
                    enum:
                      - synchronize
                  status:
                    type: string
                    enum:
                      - active
                      - paused
                      - error
                  syncIntervalMinutes:
                    type: number
                  lastSyncAt:
                    type:
                      - number
                      - 'null'
                  nextSyncAt:
                    type:
                      - number
                      - 'null'
                  lastFullListAt:
                    type:
                      - number
                      - 'null'
                  consecutiveFailures:
                    type: integer
                    minimum: 0
                  lastError:
                    type:
                      - string
                      - 'null'
                required:
                  - id
                  - name
                  - providerKey
                  - namespace
                  - targetScopeType
                  - mode
                  - status
                  - syncIntervalMinutes
                  - lastSyncAt
                  - nextSyncAt
                  - lastFullListAt
                  - consecutiveFailures
                  - lastError
                additionalProperties: false
            truncated:
              type: boolean
          required:
            - scope
            - items
            - truncated
          additionalProperties: false
        sourceItems:
          type: object
          properties:
            scope:
              type: string
              const: readable
            items:
              type: array
              items:
                anyOf:
                  - type: object
                    properties:
                      sourceId:
                        type: string
                        minLength: 1
                      sourceName:
                        type: string
                      attempts:
                        type: integer
                        minimum: 0
                      quarantined:
                        type: boolean
                      restricted:
                        type: boolean
                        const: false
                      lastError:
                        type: string
                      firstFailedAt:
                        type: number
                      lastFailedAt:
                        type: number
                    required:
                      - sourceId
                      - sourceName
                      - attempts
                      - quarantined
                      - restricted
                      - lastError
                      - firstFailedAt
                      - lastFailedAt
                    additionalProperties: false
                  - type: object
                    properties:
                      sourceId:
                        type: string
                        minLength: 1
                      sourceName:
                        type: string
                      attempts:
                        type: integer
                        minimum: 0
                      quarantined:
                        type: boolean
                      restricted:
                        type: boolean
                        const: true
                      lastError:
                        type: 'null'
                      firstFailedAt:
                        type: number
                      lastFailedAt:
                        type: number
                    required:
                      - sourceId
                      - sourceName
                      - attempts
                      - quarantined
                      - restricted
                      - lastError
                      - firstFailedAt
                      - lastFailedAt
                    additionalProperties: false
            truncated:
              type: boolean
          required:
            - scope
            - items
            - truncated
          additionalProperties: false
        embeddings:
          type: object
          properties:
            scope:
              type: string
              const: readable
            referenceModelId:
              type:
                - string
                - 'null'
            referenceDimension:
              type:
                - number
                - 'null'
            namespaces:
              type: array
              items:
                type: object
                properties:
                  namespace:
                    type: string
                  modelId:
                    type:
                      - string
                      - 'null'
                  dimension:
                    type:
                      - number
                      - 'null'
                  stale:
                    type: boolean
                required:
                  - namespace
                  - modelId
                  - dimension
                  - stale
                additionalProperties: false
            truncated:
              type: boolean
          required:
            - scope
            - referenceModelId
            - referenceDimension
            - namespaces
            - truncated
          additionalProperties: false
        syncLag:
          type: object
          properties:
            scope:
              type: string
              const: readable
            overdueCount:
              type: integer
              minimum: 0
            oldestOverdueAt:
              type:
                - number
                - 'null'
            truncated:
              type: boolean
          required:
            - scope
            - overdueCount
            - oldestOverdueAt
            - truncated
          additionalProperties: false
        quality:
          type: object
          properties:
            scope:
              type: string
              const: readable
            openReviewItems:
              type: integer
              minimum: 0
            truncated:
              type: boolean
          required:
            - scope
            - openReviewItems
            - truncated
          additionalProperties: false
        reembed:
          type: object
          properties:
            scope:
              type: string
              const: deployment
            latestRun:
              anyOf:
                - type: object
                  properties:
                    status:
                      type: string
                      enum:
                        - running
                        - completed
                        - failed
                    targetModelId:
                      type: string
                    targetDimension:
                      type: number
                    startedAt:
                      type: number
                    finishedAt:
                      type:
                        - number
                        - 'null'
                    namespacesTotal:
                      type: integer
                      minimum: 0
                    namespacesDone:
                      type: integer
                      minimum: 0
                    entriesReembedded:
                      type: integer
                      minimum: 0
                    entriesSkipped:
                      type: integer
                      minimum: 0
                    entriesFailed:
                      type: integer
                      minimum: 0
                    failedInReadable:
                      type: integer
                      minimum: 0
                    hasError:
                      type: boolean
                  required:
                    - status
                    - targetModelId
                    - targetDimension
                    - startedAt
                    - finishedAt
                    - namespacesTotal
                    - namespacesDone
                    - entriesReembedded
                    - entriesSkipped
                    - entriesFailed
                    - failedInReadable
                    - hasError
                  additionalProperties: false
                - type: 'null'
          required:
            - scope
            - latestRun
          additionalProperties: false
        integrity:
          type: object
          properties:
            scope:
              type: string
              const: deployment
            lap:
              anyOf:
                - type: object
                  properties:
                    lapStartedAt:
                      type: number
                    lapsCompleted:
                      type: integer
                      minimum: 0
                    rowsCheckedThisLap:
                      type: integer
                      minimum: 0
                    lastFindingCount:
                      type: integer
                      minimum: 0
                    updatedAt:
                      type: number
                  required:
                    - lapStartedAt
                    - lapsCompleted
                    - rowsCheckedThisLap
                    - lastFindingCount
                    - updatedAt
                  additionalProperties: false
                - type: 'null'
          required:
            - scope
            - lap
          additionalProperties: false
        sweeps:
          type: object
          properties:
            scope:
              type: string
              const: deployment
            crons:
              type: array
              items:
                type: object
                properties:
                  cronName:
                    type: string
                  lastRun:
                    anyOf:
                      - type: object
                        properties:
                          status:
                            type: string
                            enum:
                              - pending
                              - completed
                              - failed
                              - canceled
                              - skipped
                              - unknown
                          trigger:
                            type: string
                            enum:
                              - cron
                              - manual
                          startedAt:
                            type: number
                          completedAt:
                            type:
                              - number
                              - 'null'
                          durationMs:
                            type:
                              - number
                              - 'null'
                        required:
                          - status
                          - trigger
                          - startedAt
                          - completedAt
                          - durationMs
                        additionalProperties: false
                      - type: 'null'
                  lastFailureAt:
                    type:
                      - number
                      - 'null'
                required:
                  - cronName
                  - lastRun
                  - lastFailureAt
                additionalProperties: false
          required:
            - scope
            - crons
          additionalProperties: false
        settings:
          type: object
          properties:
            scope:
              type: string
              const: deployment
            learning:
              type: object
              properties:
                gradeRankWeights:
                  type: object
                  properties:
                    provisional:
                      type: number
                    proven:
                      type: number
                    contested:
                      type: number
                    ungraded:
                      type: number
                  required:
                    - provisional
                    - proven
                    - contested
                    - ungraded
                  additionalProperties: false
                evidenceLogCap:
                  type: number
                provenThresholds:
                  type: object
                  additionalProperties:
                    type: object
                    properties:
                      provenAfterSuccesses:
                        type: number
                    required:
                      - provenAfterSuccesses
                    additionalProperties: false
                signalPrecedence:
                  type: array
                  items:
                    type: string
                ratingSignal:
                  type: object
                  properties:
                    successAtOrAbove:
                      type: number
                    failureAtOrBelow:
                      type: number
                  required:
                    - successAtOrAbove
                    - failureAtOrBelow
                  additionalProperties: false
                failedRunSignal:
                  type: boolean
                distillationMinClusterSize:
                  type: number
                distillationMinScore:
                  type: number
                distillationScopes:
                  type: array
                  items:
                    type: string
                staleAfterDays:
                  type: number
                memoryPromotionRetrievalThreshold:
                  type: number
                federatedDefaultTrustWeight:
                  type: number
              required:
                - gradeRankWeights
                - evidenceLogCap
                - provenThresholds
                - signalPrecedence
                - ratingSignal
                - failedRunSignal
                - distillationMinClusterSize
                - distillationMinScore
                - distillationScopes
                - staleAfterDays
                - memoryPromotionRetrievalThreshold
                - federatedDefaultTrustWeight
              additionalProperties: false
            chatLtmPromotionThreshold:
              type: number
            overriddenKeys:
              type: array
              items:
                type: string
            partlyApplied:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  ignoredParts:
                    type: array
                    items:
                      type: string
                  defaultedParts:
                    type: array
                    items:
                      type: string
                required:
                  - key
                  - ignoredParts
                  - defaultedParts
                additionalProperties: false
            ignoredKeys:
              type: array
              items:
                type: string
            updatedAt:
              type: object
              additionalProperties:
                type: number
          required:
            - scope
            - learning
            - chatLtmPromotionThreshold
            - overriddenKeys
            - partlyApplied
            - ignoredKeys
            - updatedAt
          additionalProperties: false
      required:
        - pending
        - sources
        - sourceItems
        - embeddings
        - syncLag
        - quality
        - reembed
        - integrity
        - sweeps
        - settings
      additionalProperties: false
      description: >-
        What is broken in the knowledge the caller can read, and how far behind
        it is: the Console health projection, read as no person. Sections with
        scope `readable` cover only the caller's readable namespaces (or the one
        selected); sections with scope `deployment` are deployment-wide. Source
        configuration, cursors and case keys are never returned; a source's last
        error is redacted, a failing item whose case the caller may not read is
        `restricted` with no error, and the re-embed run's error text is
        withheld (`hasError`). Each list is bounded and says `truncated` when
        the bounded read stopped early.
    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
    ErrorResponse403:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - forbidden
                    - permission_denied
                    - operator_stopped
    ErrorResponse500:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - internal_error
    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.