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

# Preview pod customer assignment

> Preview a Customer assignment change. Requires permission `workforce:manage`.

Previews one assignment change (`assign`, `change-effective`, `update-future` or `end`, each with that write's body as `args`) as the Console does and changes nothing. `status: "ready"` carries the pod, the Customer, the operation to confirm and, except for an end, the pod's capacity with the overlapping assignments on that pod; `status: "blocked"` carries the refusal code and the Console's message. It requires `workforce:manage` at the platform scope, and the credential's scopes must include `workforce:manage`; no `customers:read` is needed. An unknown or unreadable pod or assignment, and a pod managed by or under a customer organization, return `404`. It takes no `Idempotency-Key` and is never replayed.


## OpenAPI

````yaml /forge/reference/openapi-v3.json post /api/v3/pods/preview-customer-assignment
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/pods/preview-customer-assignment:
    post:
      tags:
        - Workforce
      summary: Preview a Customer assignment change
      description: >-
        Requires permission `workforce:manage`.


        Runs the Console's checks for one assignment change without writing
        anything: `ready` returns the pod, the Customer, the operation to
        confirm and, except for an end, the pod's capacity numbers with the
        overlapping assignments on that pod; `blocked` returns the refusal code
        and the Console's message. Requires `workforce:manage` at the platform
        scope (Console parity); a key or app whose grant covers only some org
        units receives 403. A pod whose managing org unit is a customer
        organization or sits under one answers 404 exactly as a missing pod, and
        so does an assignment of such a pod; an unknown or unreadable pod or
        assignment answers 404 as well. A read carried in a POST body: no
        `Idempotency-Key` and no replay. Customer names, types and statuses are
        part of the Workforce projection: no `customers:read` is required
        (Console parity).
      operationId: previewPodCustomerAssignment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewPodCustomerAssignmentRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WorkforcePodCustomerAssignmentPreview'
                  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: Error
          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: Error
          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: Error
          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: Error
          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'
        '413':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse413'
          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: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse500'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
        '503':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse503'
          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'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
      security:
        - BearerAuth: []
        - PlatformApiKey: []
        - PersonalKey: []
components:
  schemas:
    PreviewPodCustomerAssignmentRequest:
      type: object
      properties:
        operation:
          anyOf:
            - type: object
              properties:
                kind:
                  type: string
                  const: assign
                args:
                  type: object
                  properties:
                    podId:
                      type: string
                      minLength: 1
                      description: The pod's ID.
                    customerId:
                      type: string
                      minLength: 1
                      description: An active Organization Customer.
                    allocationPercent:
                      type: number
                      description: Whole percent from 1 through 100 of the pod's capacity.
                    deliverySlices:
                      type: array
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                            minLength: 1
                            description: The slice's key, unique within the assignment.
                          allocationPercent:
                            type: number
                            description: This slice's share of the assignment.
                          deliveryType:
                            type: string
                            enum:
                              - msp
                              - project
                              - platform
                              - forward_deployed
                          categoryKey:
                            type: string
                            description: An active reporting category key.
                          stage:
                            type: string
                            enum:
                              - pre_deal
                              - engaged
                        required:
                          - key
                          - allocationPercent
                        additionalProperties: false
                      description: >-
                        How the allocation splits by delivery type, category and
                        stage.
                    startsAt:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                      description: >-
                        When the assignment starts (a UTC day boundary), epoch
                        milliseconds.
                    endsAt:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                      description: When it ends (a UTC day boundary), epoch milliseconds.
                  required:
                    - podId
                    - customerId
                    - allocationPercent
                    - startsAt
                  additionalProperties: false
              required:
                - kind
                - args
              additionalProperties: false
            - type: object
              properties:
                kind:
                  type: string
                  const: change-effective
                args:
                  type: object
                  properties:
                    assignmentId:
                      type: string
                      minLength: 1
                      description: The Pod-to-Customer assignment's ID.
                    effectiveAt:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                      description: >-
                        When the change takes effect (a UTC day boundary), epoch
                        milliseconds.
                    allocationPercent:
                      type: number
                      description: Whole percent from 1 through 100 of the pod's capacity.
                    deliverySlices:
                      type: array
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                            minLength: 1
                            description: The slice's key, unique within the assignment.
                          allocationPercent:
                            type: number
                            description: This slice's share of the assignment.
                          deliveryType:
                            type: string
                            enum:
                              - msp
                              - project
                              - platform
                              - forward_deployed
                          categoryKey:
                            type: string
                            description: An active reporting category key.
                          stage:
                            type: string
                            enum:
                              - pre_deal
                              - engaged
                        required:
                          - key
                          - allocationPercent
                        additionalProperties: false
                      description: >-
                        How the allocation splits by delivery type, category and
                        stage.
                    endsAt:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                      description: When the successor ends, epoch milliseconds.
                    expectedRevision:
                      type: integer
                      minimum: 0
                      description: >-
                        The assignment's revision you last read; a stale value
                        is refused.
                    correctionReason:
                      type: string
                      description: >-
                        Required by the command when the change reaches back
                        before today (UTC).
                  required:
                    - assignmentId
                    - effectiveAt
                    - allocationPercent
                    - expectedRevision
                  additionalProperties: false
              required:
                - kind
                - args
              additionalProperties: false
            - type: object
              properties:
                kind:
                  type: string
                  const: update-future
                args:
                  type: object
                  properties:
                    assignmentId:
                      type: string
                      minLength: 1
                      description: The Pod-to-Customer assignment's ID.
                    allocationPercent:
                      type: number
                      description: Whole percent from 1 through 100 of the pod's capacity.
                    deliverySlices:
                      type: array
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                            minLength: 1
                            description: The slice's key, unique within the assignment.
                          allocationPercent:
                            type: number
                            description: This slice's share of the assignment.
                          deliveryType:
                            type: string
                            enum:
                              - msp
                              - project
                              - platform
                              - forward_deployed
                          categoryKey:
                            type: string
                            description: An active reporting category key.
                          stage:
                            type: string
                            enum:
                              - pre_deal
                              - engaged
                        required:
                          - key
                          - allocationPercent
                        additionalProperties: false
                      description: >-
                        How the allocation splits by delivery type, category and
                        stage.
                    startsAt:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                      description: >-
                        The new start (a future UTC day boundary), epoch
                        milliseconds.
                    endsAt:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                      description: When it ends, epoch milliseconds.
                    expectedRevision:
                      type: integer
                      minimum: 0
                      description: >-
                        The assignment's revision you last read; a stale value
                        is refused.
                  required:
                    - assignmentId
                    - allocationPercent
                    - startsAt
                    - expectedRevision
                  additionalProperties: false
              required:
                - kind
                - args
              additionalProperties: false
            - type: object
              properties:
                kind:
                  type: string
                  const: end
                args:
                  type: object
                  properties:
                    assignmentId:
                      type: string
                      minLength: 1
                      description: The Pod-to-Customer assignment's ID.
                    endsAt:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                      description: >-
                        When the assignment ends (a UTC day boundary), epoch
                        milliseconds.
                    expectedRevision:
                      type: integer
                      minimum: 0
                      description: >-
                        The assignment's revision you last read; a stale value
                        is refused.
                    correctionReason:
                      type: string
                      description: >-
                        Required by the command when the change reaches back
                        before today (UTC).
                  required:
                    - assignmentId
                    - endsAt
                    - expectedRevision
                  additionalProperties: false
              required:
                - kind
                - args
              additionalProperties: false
      required:
        - operation
      additionalProperties: false
      description: >-
        One Pod-to-Customer assignment change to preview, in the Console's
        operation shape: assign, change-effective, update-future or end. Unknown
        fields are refused.
    WorkforcePodCustomerAssignmentPreview:
      anyOf:
        - type: object
          properties:
            status:
              type: string
              const: ready
            pod:
              type: object
              properties:
                id:
                  type: string
                  minLength: 1
                _creationTime:
                  type: number
                podKey:
                  type: string
                name:
                  type: string
                description:
                  type: string
                managingOrgUnitId:
                  type: string
                status:
                  type: string
                  enum:
                    - active
                    - archived
                membershipRevision:
                  type: integer
                  minimum: 0
                createdAt:
                  type: number
                updatedAt:
                  type: number
                archivedAt:
                  type: number
              required:
                - id
                - _creationTime
                - podKey
                - name
                - managingOrgUnitId
                - status
                - membershipRevision
                - createdAt
                - updatedAt
              additionalProperties: false
            customer:
              type: object
              properties:
                id:
                  type: string
                name:
                  type: string
                customerType:
                  type: string
                  enum:
                    - org
                    - user
                status:
                  type: string
                  enum:
                    - active
                    - inactive
                    - archived
              required:
                - id
                - name
                - customerType
                - status
              additionalProperties: false
            confirmation:
              anyOf:
                - type: object
                  properties:
                    kind:
                      type: string
                      const: assign
                    args:
                      type: object
                      properties:
                        podId:
                          type: string
                          minLength: 1
                          description: The pod's ID.
                        customerId:
                          type: string
                          minLength: 1
                          description: An active Organization Customer.
                        allocationPercent:
                          type: number
                          description: >-
                            Whole percent from 1 through 100 of the pod's
                            capacity.
                        deliverySlices:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                minLength: 1
                                description: The slice's key, unique within the assignment.
                              allocationPercent:
                                type: number
                                description: This slice's share of the assignment.
                              deliveryType:
                                type: string
                                enum:
                                  - msp
                                  - project
                                  - platform
                                  - forward_deployed
                              categoryKey:
                                type: string
                                description: An active reporting category key.
                              stage:
                                type: string
                                enum:
                                  - pre_deal
                                  - engaged
                            required:
                              - key
                              - allocationPercent
                            additionalProperties: false
                          description: >-
                            How the allocation splits by delivery type, category
                            and stage.
                        startsAt:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                          description: >-
                            When the assignment starts (a UTC day boundary),
                            epoch milliseconds.
                        endsAt:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                          description: >-
                            When it ends (a UTC day boundary), epoch
                            milliseconds.
                      required:
                        - podId
                        - customerId
                        - allocationPercent
                        - startsAt
                      additionalProperties: false
                  required:
                    - kind
                    - args
                  additionalProperties: false
                - type: object
                  properties:
                    kind:
                      type: string
                      const: change-effective
                    args:
                      type: object
                      properties:
                        assignmentId:
                          type: string
                          minLength: 1
                          description: The Pod-to-Customer assignment's ID.
                        effectiveAt:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                          description: >-
                            When the change takes effect (a UTC day boundary),
                            epoch milliseconds.
                        allocationPercent:
                          type: number
                          description: >-
                            Whole percent from 1 through 100 of the pod's
                            capacity.
                        deliverySlices:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                minLength: 1
                                description: The slice's key, unique within the assignment.
                              allocationPercent:
                                type: number
                                description: This slice's share of the assignment.
                              deliveryType:
                                type: string
                                enum:
                                  - msp
                                  - project
                                  - platform
                                  - forward_deployed
                              categoryKey:
                                type: string
                                description: An active reporting category key.
                              stage:
                                type: string
                                enum:
                                  - pre_deal
                                  - engaged
                            required:
                              - key
                              - allocationPercent
                            additionalProperties: false
                          description: >-
                            How the allocation splits by delivery type, category
                            and stage.
                        endsAt:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                          description: When the successor ends, epoch milliseconds.
                        expectedRevision:
                          type: integer
                          minimum: 0
                          description: >-
                            The assignment's revision you last read; a stale
                            value is refused.
                        correctionReason:
                          type: string
                          description: >-
                            Required by the command when the change reaches back
                            before today (UTC).
                      required:
                        - assignmentId
                        - effectiveAt
                        - allocationPercent
                        - expectedRevision
                      additionalProperties: false
                  required:
                    - kind
                    - args
                  additionalProperties: false
                - type: object
                  properties:
                    kind:
                      type: string
                      const: update-future
                    args:
                      type: object
                      properties:
                        assignmentId:
                          type: string
                          minLength: 1
                          description: The Pod-to-Customer assignment's ID.
                        allocationPercent:
                          type: number
                          description: >-
                            Whole percent from 1 through 100 of the pod's
                            capacity.
                        deliverySlices:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                minLength: 1
                                description: The slice's key, unique within the assignment.
                              allocationPercent:
                                type: number
                                description: This slice's share of the assignment.
                              deliveryType:
                                type: string
                                enum:
                                  - msp
                                  - project
                                  - platform
                                  - forward_deployed
                              categoryKey:
                                type: string
                                description: An active reporting category key.
                              stage:
                                type: string
                                enum:
                                  - pre_deal
                                  - engaged
                            required:
                              - key
                              - allocationPercent
                            additionalProperties: false
                          description: >-
                            How the allocation splits by delivery type, category
                            and stage.
                        startsAt:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                          description: >-
                            The new start (a future UTC day boundary), epoch
                            milliseconds.
                        endsAt:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                          description: When it ends, epoch milliseconds.
                        expectedRevision:
                          type: integer
                          minimum: 0
                          description: >-
                            The assignment's revision you last read; a stale
                            value is refused.
                      required:
                        - assignmentId
                        - allocationPercent
                        - startsAt
                        - expectedRevision
                      additionalProperties: false
                  required:
                    - kind
                    - args
                  additionalProperties: false
                - type: object
                  properties:
                    kind:
                      type: string
                      const: end
                    args:
                      type: object
                      properties:
                        assignmentId:
                          type: string
                          minLength: 1
                          description: The Pod-to-Customer assignment's ID.
                        endsAt:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                          description: >-
                            When the assignment ends (a UTC day boundary), epoch
                            milliseconds.
                        expectedRevision:
                          type: integer
                          minimum: 0
                          description: >-
                            The assignment's revision you last read; a stale
                            value is refused.
                        correctionReason:
                          type: string
                          description: >-
                            Required by the command when the change reaches back
                            before today (UTC).
                      required:
                        - assignmentId
                        - endsAt
                        - expectedRevision
                      additionalProperties: false
                  required:
                    - kind
                    - args
                  additionalProperties: false
            capacity:
              type: object
              properties:
                candidate:
                  type: object
                  properties:
                    deliverySlices:
                      type: array
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                            minLength: 1
                            description: The slice's key, unique within the assignment.
                          allocationPercent:
                            type: number
                            description: This slice's share of the assignment.
                          deliveryType:
                            type: string
                            enum:
                              - msp
                              - project
                              - platform
                              - forward_deployed
                          categoryKey:
                            type: string
                            description: An active reporting category key.
                          stage:
                            type: string
                            enum:
                              - pre_deal
                              - engaged
                          categoryLabelSnapshot:
                            type: string
                        required:
                          - key
                          - allocationPercent
                        additionalProperties: false
                    podId:
                      type: string
                    customerId:
                      type: string
                    allocationPercent:
                      type: number
                    startsAt:
                      type: number
                    endsAt:
                      type: number
                  required:
                    - podId
                    - customerId
                    - allocationPercent
                    - startsAt
                  additionalProperties: false
                committedPeakPercent:
                  type: number
                proposedPeakPercent:
                  type: number
                projectedPeakPercent:
                  type: number
                projectedAvailablePercent:
                  type: number
                conflict:
                  type: boolean
                overlappingAssignments:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                      _creationTime:
                        type: number
                      deliverySlices:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              minLength: 1
                              description: The slice's key, unique within the assignment.
                            allocationPercent:
                              type: number
                              description: This slice's share of the assignment.
                            deliveryType:
                              type: string
                              enum:
                                - msp
                                - project
                                - platform
                                - forward_deployed
                            categoryKey:
                              type: string
                              description: An active reporting category key.
                            stage:
                              type: string
                              enum:
                                - pre_deal
                                - engaged
                            categoryLabelSnapshot:
                              type: string
                          required:
                            - key
                            - allocationPercent
                          additionalProperties: false
                      podId:
                        type: string
                      customerId:
                        type: string
                      allocationPercent:
                        type: number
                      startsAt:
                        type: number
                      endsAt:
                        type: number
                      effectiveEndAt:
                        type: number
                      revision:
                        type: integer
                      supersedesAssignmentId:
                        type: string
                        description: >-
                          The assignment this one succeeded on a change of
                          effective terms.
                      createdAt:
                        type: number
                      updatedAt:
                        type: number
                      verifiedAt:
                        type: number
                      verificationDueAt:
                        type: number
                    required:
                      - id
                      - _creationTime
                      - podId
                      - customerId
                      - allocationPercent
                      - startsAt
                      - effectiveEndAt
                      - revision
                      - createdAt
                      - updatedAt
                      - verifiedAt
                      - verificationDueAt
                    additionalProperties: false
              required:
                - candidate
                - committedPeakPercent
                - proposedPeakPercent
                - projectedPeakPercent
                - projectedAvailablePercent
                - conflict
                - overlappingAssignments
              additionalProperties: false
          required:
            - status
            - pod
            - customer
            - confirmation
          additionalProperties: false
        - type: object
          properties:
            status:
              type: string
              const: blocked
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - POD_CUSTOMER_ASSIGNMENT_CHANGED
                    - POD_CUSTOMER_ASSIGNMENT_ENDED
                    - POD_CUSTOMER_INTERVAL_INVALID
                    - POD_CUSTOMER_ALLOCATION_INVALID
                    - POD_CUSTOMER_DATE_CONFLICT
                    - POD_CUSTOMER_CAPACITY_EXCEEDED
                    - POD_CUSTOMER_FUTURE_ONLY
                    - POD_CUSTOMER_CORRECTION_REASON_REQUIRED
                    - POD_CUSTOMER_READ_LIMIT_EXCEEDED
                    - POD_ARCHIVED
                    - CUSTOMER_NOT_FOUND
                    - CUSTOMER_NOT_ORGANIZATION
                    - CUSTOMER_INACTIVE
                    - CUSTOMER_ARCHIVED
                    - DELIVERY_CLASSIFICATION_INVALID
                    - POD_INTERNAL_PROFILE_CONFLICT
                message:
                  type: string
              required:
                - code
                - message
              additionalProperties: false
          required:
            - status
            - error
          additionalProperties: false
      description: >-
        ready: the pod, the Customer, the operation to confirm and, when the
        change has a capacity window, the pod's capacity numbers with the
        overlapping assignments on that pod. blocked: a refusal code and
        message, as the Console shows them.
    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
    ErrorResponse404:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - resource_missing
    ErrorResponse413:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - payload_too_large
    ErrorResponse500:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - internal_error
    ErrorResponse503:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - internal_error
                    - governance_door_stopped
    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'
  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.