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

> ## Agent Instructions
> For agents: install the OpenWork desktop app with `brew install --cask openwork` (macOS) or from https://openworklabs.com/download. Do not run `npx openwork`; the npm package named `openwork` is a different project.
> Connect an agent to OpenWork with the MCP Gateway: `claude mcp add --transport http openwork https://api.openworklabs.com/mcp/agent`. Teams sign up at https://app.openworklabs.com?mode=sign-up.
> Step-by-step agent guide: https://openworklabs.com/docs/start-here/use-openwork-from-an-ai-agent.md
> Connect Slack (any organization admin): https://openworklabs.com/docs/slack/connect-slack.md. OpenWork in Slack (@openwork bot) is private alpha for approved organizations. Setup guide: https://openworklabs.com/docs/slack/overview.md. Agent skill: https://openworklabs.com/.well-known/agent-skills/set-up-openwork-slack/SKILL.md.

# Read the cloud runner fleet

> Every runner node as it reports itself now: whether it takes new cells, its memory against the cell host's ceiling, the cells it holds in memory and owns, and cells waiting for room. Read live from each node's state endpoint; `status` is `not_configured` when the deployment does not name the nodes. Counts, sizes and opaque cell ids only.



## OpenAPI

````yaml https://api.openworklabs.com/openapi.json?public=1 get /v1/admin/runner-fleet
openapi: 3.1.0
info:
  title: Den API
  description: >-
    OpenAPI spec for the Den control plane API.


    Authentication:

    - API keys (they start with `den_`) go in the `x-api-key` header as the raw
    value. Do not send them as `Authorization: Bearer`; that header only accepts
    Den session tokens, so an API key there returns 401.
      Example: `curl https://api.openworklabs.com/v1/me -H "x-api-key: den_..."`.
      API keys resolve to the issuing user and the organization member they were scoped to when created, so they can call ordinary user and organization routes without a separate signed-in session.
    - Use `Authorization: Bearer <session-token>` for user-authenticated routes
    that require a Den session.

    - Session-only flows still require a signed-in user session, including
    organization creation, invitation acceptance, active-organization switching,
    and MCP token minting.

    - Public routes like health and documentation do not require authentication.


    Swagger tip: use the security schemes in the Authorize dialog to set
    `denApiKey` (your API key) or `bearerAuth` (a session token) before trying
    protected endpoints.
  version: commit 0d21cde
  contact:
    name: OpenWork
    url: https://openworklabs.com
    email: team@openworklabs.com
  license:
    name: OpenWork Enterprise Edition License
    url: https://github.com/different-ai/openwork/blob/dev/ee/LICENSE
servers:
  - url: https://api.openworklabs.com
security:
  - denApiKey: []
  - bearerAuth: []
tags:
  - name: System
    description: >-
      Service health, readiness, API documentation, and desktop version
      metadata.
  - name: Authentication
    description: >-
      Sign-in discovery, administrator bootstrap, OAuth provider connections,
      and MCP token minting.
  - name: OAuth
    description: >-
      OAuth 2.0 / OpenID Connect authorization-server and protected-resource
      metadata and dynamic client registration (RFC 8414, RFC 9728, RFC 7591),
      used by MCP clients.
  - name: SCIM
    description: >-
      SCIM 2.0 provisioning endpoints for identity providers (RFC 7644) and the
      organization SCIM connector management routes.
  - name: SSO
    description: Organization single sign-on connector management routes.
  - name: Bootstrap
    description: Agent-first provisional workspace setup routes.
  - name: Users
    description: Current user and membership routes.
  - name: Organizations
    description: Organization creation, context, brand assets, and install links.
  - name: Invitations
    description: Invitation preview, acceptance, creation, and cancellation routes.
  - name: Sandbox organizations
    description: Preview and join a sandbox organization with its shareable join link.
  - name: Members
    description: Organization member management routes.
  - name: Teams
    description: Organization team management routes.
  - name: Permissions
    description: >-
      Organization permissions: the permission catalog, Member, Admin and team
      permission sets, their history, and each member's effective permissions.
  - name: API Keys
    description: Organization API key management routes.
  - name: Desktop Policies
    description: Desktop app policies applied to the organization, members, or teams.
  - name: Config blobs
    description: >-
      Export the organization's configuration as JSON and import it through
      reviewed change requests: plan, decisions, secret inputs, approval, apply
      and revert.
  - name: Agent Permissions
    description: What agents may do on members' computers, set for everyone and per team.
  - name: LLM Providers
    description: Organization LLM provider catalog, configuration, and access routes.
  - name: Inference
    description: Organization inference settings.
  - name: Inference Providers
    description: >-
      Organization inference Gateway providers, model groups, credential sets,
      access grants, member connections, and usage.
  - name: Gateway Usage Limits
    description: >-
      Estimated-cost policies, independent member calendar buckets, assignments,
      and audited usage-extension requests.
  - name: Cloud
    description: Organization Cloud instance lifecycle and browser gateway resolution.
  - name: Workers
    description: >-
      List and delete the organization's workers, including OpenWork Web
      instances.
  - name: Worker Activity
    description: Worker heartbeat and activity reporting routes.
  - name: Managed deployments
    description: >-
      OpenWork installations in an organization's own cloud account: launch
      approval, installer milestones and health reports.
  - name: Automations
    description: Scheduled Automations, their runs, and desktop runner presence.
  - name: Devices
    description: >-
      Personal and shared computers, plus permission-gated team computer
      inventory for the current organization, including registered OpenWork
      instances. Inventory grants no control or access to private content.
  - name: Documents
    description: >-
      Connected Drive documents, inline editing and file-bound temporary Office
      sessions.
  - name: Workbot
    description: The signed-in member's single Workbot conversation.
  - name: Workflows
    description: Saved Workflows (Code Mode scripts), their versions, snapshots, and views.
  - name: Workflow Runs
    description: Durable Workflow run history.
  - name: Codemode Runs
    description: Generated Artifact views produced by Code Mode runs.
  - name: Artifacts
    description: >-
      Reusable interactive views, including saved Workflow views, and their
      sharing.
  - name: Config Objects
    description: >-
      Versioned configuration objects (skills, workflows, and other plugin
      content).
  - name: Plugins
    description: Plugin packages, access grants, and imports.
  - name: Marketplaces
    description: Marketplaces that distribute plugins to members and teams.
  - name: Resources
    description: >-
      Aggregated snapshot of the resources and marketplace capabilities
      available to the caller.
  - name: Capability Sources
    description: >-
      Native provider capabilities (Google Workspace, Microsoft 365) and
      external MCP connections executed as the calling member.
  - name: Direct uploads
    description: Multipart uploads that stream workspace files straight to a provider.
  - name: Connectors
    description: >-
      Connector accounts and instances (GitHub and other sources) and their sync
      state.
  - name: GitHub
    description: >-
      GitHub App installation, repository discovery, and plugin import from
      GitHub.
  - name: Diagnostics
    description: >-
      Settings › Diagnostics: desktop app startups, model providers, connectors
      and installation services.
  - name: Telemetry
    description: Telemetry event ingestion and adoption analytics.
  - name: Webhooks
    description: Signed inbound webhooks from third-party providers.
  - name: Admin
    description: Platform administration routes for allowlisted OpenWork administrators.
  - name: Deprecated
    description: Removed features that answer with 410 or an empty result for old clients.
paths:
  /v1/admin/runner-fleet:
    get:
      tags:
        - Admin
      summary: Read the cloud runner fleet
      description: >-
        Every runner node as it reports itself now: whether it takes new cells,
        its memory against the cell host's ceiling, the cells it holds in memory
        and owns, and cells waiting for room. Read live from each node's state
        endpoint; `status` is `not_configured` when the deployment does not name
        the nodes. Counts, sizes and opaque cell ids only.
      operationId: getV1AdminRunnerFleet
      responses:
        '200':
          description: The fleet now.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminRunnerFleet'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: Platform admin access required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
      security:
        - denApiKey: []
        - bearerAuth: []
components:
  schemas:
    AdminRunnerFleet:
      type: object
      properties:
        status:
          type: string
          enum:
            - not_configured
            - healthy
            - warning
            - alert
            - unreachable
        generatedAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
        nodes:
          maxItems: 64
          type: array
          items:
            $ref: '#/components/schemas/AdminRunnerFleetNode'
        totals:
          type: object
          properties:
            nodes:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            reachable:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            closed:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            residentCells:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            ownedCells:
              anyOf:
                - type: integer
                  minimum: 0
                  maximum: 9007199254740991
                - type: 'null'
            waitingForRoom:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            usedBytes:
              type: integer
              minimum: 0
              maximum: 9007199254740991
          required:
            - nodes
            - reachable
            - closed
            - residentCells
            - ownedCells
            - waitingForRoom
            - usedBytes
        discoveryError:
          anyOf:
            - type: string
              maxLength: 40
            - type: 'null'
        cellNamesError:
          default: null
          anyOf:
            - type: string
              maxLength: 40
            - type: 'null'
      required:
        - status
        - generatedAt
        - nodes
        - totals
        - discoveryError
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          const: unauthorized
      required:
        - error
    ForbiddenError:
      type: object
      properties:
        error:
          type: string
          enum:
            - forbidden
            - reauth
        reason:
          type: string
        message:
          type: string
      required:
        - error
    AdminRunnerFleetNode:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 64
        state:
          type: string
          enum:
            - open
            - no_headroom
            - closed
            - draining
            - unreachable
        error:
          anyOf:
            - type: string
              maxLength: 40
            - type: 'null'
        shedReason:
          anyOf:
            - type: string
              maxLength: 40
            - type: 'null'
        memory:
          type: object
          properties:
            usedBytes:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            limitBytes:
              anyOf:
                - type: integer
                  minimum: 0
                  maximum: 9007199254740991
                - type: 'null'
            ratio:
              anyOf:
                - type: number
                  minimum: 0
                  maximum: 100
                - type: 'null'
            residentBytes:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            inUseBytes:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            workingSetBytes:
              anyOf:
                - type: integer
                  minimum: 0
                  maximum: 9007199254740991
                - type: 'null'
            retainedBytes:
              anyOf:
                - type: integer
                  minimum: 0
                  maximum: 9007199254740991
                - type: 'null'
            heapBytes:
              anyOf:
                - type: integer
                  minimum: 0
                  maximum: 9007199254740991
                - type: 'null'
            externalBytes:
              anyOf:
                - type: integer
                  minimum: 0
                  maximum: 9007199254740991
                - type: 'null'
          required:
            - usedBytes
            - limitBytes
            - ratio
            - residentBytes
            - inUseBytes
            - workingSetBytes
            - retainedBytes
            - heapBytes
            - externalBytes
        cells:
          type: object
          properties:
            resident:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            owned:
              anyOf:
                - type: integer
                  minimum: 0
                  maximum: 9007199254740991
                - type: 'null'
            waitingForRoom:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            starting:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            residents:
              maxItems: 600
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 16
            residentsTruncated:
              type: boolean
            inMemory:
              default: []
              maxItems: 300
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                    maxLength: 16
                  since:
                    anyOf:
                      - type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                      - type: 'null'
                  kind:
                    type: string
                    enum:
                      - conversation
                      - person
                      - service
                      - unknown
                  product:
                    anyOf:
                      - type: string
                        enum:
                          - workbot
                          - slack
                          - automation
                      - type: 'null'
                  organization:
                    anyOf:
                      - type: object
                        properties:
                          id:
                            type: string
                            minLength: 1
                            maxLength: 64
                          name:
                            type: string
                            maxLength: 200
                        required:
                          - id
                          - name
                      - type: 'null'
                  lastActiveAt:
                    anyOf:
                      - type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                      - type: 'null'
                  turnRunning:
                    type: boolean
                required:
                  - id
                  - since
                  - kind
                  - product
                  - organization
                  - lastActiveAt
                  - turnRunning
          required:
            - resident
            - owned
            - waitingForRoom
            - starting
            - residents
            - residentsTruncated
        sockets:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        cpuPercent:
          anyOf:
            - type: number
              minimum: 0
              maximum: 100000
            - type: 'null'
        moved:
          type: object
          properties:
            handedOff:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            rebalanced:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            shed:
              type: integer
              minimum: 0
              maximum: 9007199254740991
          required:
            - handedOff
            - rebalanced
            - shed
        isolates:
          anyOf:
            - type: object
              properties:
                live:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                retiring:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
              required:
                - live
                - retiring
            - type: 'null'
        version:
          anyOf:
            - type: string
              maxLength: 80
            - type: 'null'
      required:
        - id
        - state
        - error
        - shedReason
        - memory
        - cells
        - sockets
        - cpuPercent
        - moved
        - isolates
        - version
  securitySchemes:
    denApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Organization API key passed as the `x-api-key` header. The raw key is
        the header value; do not prefix it with `Bearer`.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: session-token
      description: >-
        Den session token passed as `Authorization: Bearer <session-token>` for
        user-authenticated Den routes. Not for API keys: send `den_` keys in the
        `x-api-key` header instead.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.