> ## 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
> OpenWork in Slack 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.

# Get free Auto usage across all organizations

> Returns free Auto usage for the last `days` UTC days: platform totals, members and guests, a daily series, this week's allowance pressure, and usage per organization. Guests are reported only in aggregate.



## OpenAPI

````yaml /openapi.json get /v1/admin/free-auto/usage
openapi: 3.1.0
info:
  title: Den API
  description: >-
    OpenAPI spec for the Den control plane API.


    Authentication:

    - Use `Authorization: Bearer <session-token>` for user-authenticated routes
    that require a Den session.

    - Use `x-api-key: <den-api-key>` for organization API-key calls. 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.
      Example: `curl https://api.openworklabs.com/v1/me -H "x-api-key: den_..."`.
    - 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 either
    `bearerAuth` or `denApiKey` before trying protected endpoints.
  version: 0.18.46
  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:
  - bearerAuth: []
  - denApiKey: []
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: Members
    description: Organization member management routes.
  - name: Roles
    description: Organization custom role management routes.
  - name: Teams
    description: Organization team management routes.
  - name: API Keys
    description: Organization API key management routes.
  - name: Desktop Policies
    description: Desktop app policies applied to the organization, members, or teams.
  - 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: Worker lifecycle, billing, and runtime routes.
  - name: Worker Runtime
    description: Worker runtime inspection and upgrade routes.
  - name: Worker Activity
    description: Worker heartbeat and activity reporting routes.
  - name: Automations
    description: Scheduled Automations, their runs, and desktop runner presence.
  - 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: Apps
    description: >-
      Saved reusable apps built from Workflows and Artifact 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: Dashboards
    description: Shared dashboards and their access grants.
  - 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: Controlled egress diagnostics for self-hosted deployments.
  - 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/free-auto/usage:
    get:
      tags:
        - Admin
      summary: Get free Auto usage across all organizations
      description: >-
        Returns free Auto usage for the last `days` UTC days: platform totals,
        members and guests, a daily series, this week's allowance pressure, and
        usage per organization. Guests are reported only in aggregate.
      operationId: getV1AdminFreeAutoUsage
      parameters:
        - in: query
          name: days
          schema:
            default: 30
            type: integer
            minimum: 1
            maximum: 90
      responses:
        '200':
          description: Free Auto usage returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminFreeAutoUsageResponse'
        '400':
          description: The query parameters were invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
        '401':
          description: The caller must be authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: The authenticated user is not an admin.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
      security:
        - bearerAuth: []
        - denApiKey: []
components:
  schemas:
    AdminFreeAutoUsageResponse:
      type: object
      properties:
        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))$
        range:
          type: object
          properties:
            days:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            from:
              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))$
            to:
              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))$
            timezone:
              type: string
              const: UTC
          required:
            - days
            - from
            - to
            - timezone
        settings:
          type: object
          properties:
            membersEnabled:
              type: boolean
            rolloutAllOrganizations:
              type: boolean
            weeklyLimitMicroUsd:
              type: integer
              minimum: 0
              maximum: 9007199254740991
          required:
            - membersEnabled
            - rolloutAllOrganizations
            - weeklyLimitMicroUsd
        totals:
          type: object
          properties:
            costMicroUsd:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            requests:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            estimatedRequests:
              type: integer
              minimum: 0
              maximum: 9007199254740991
              description: >-
                Requests charged the fixed estimate because OpenAI reported no
                usage.
            inputTokens:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            outputTokens:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            activePeople:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            activeOrganizations:
              type: integer
              minimum: 0
              maximum: 9007199254740991
          required:
            - costMicroUsd
            - requests
            - estimatedRequests
            - inputTokens
            - outputTokens
            - activePeople
            - activeOrganizations
        members:
          type: object
          properties:
            costMicroUsd:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            requests:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            estimatedRequests:
              type: integer
              minimum: 0
              maximum: 9007199254740991
              description: >-
                Requests charged the fixed estimate because OpenAI reported no
                usage.
            inputTokens:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            outputTokens:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            activePeople:
              type: integer
              minimum: 0
              maximum: 9007199254740991
          required:
            - costMicroUsd
            - requests
            - estimatedRequests
            - inputTokens
            - outputTokens
            - activePeople
        guests:
          type: object
          properties:
            costMicroUsd:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            requests:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            estimatedRequests:
              type: integer
              minimum: 0
              maximum: 9007199254740991
              description: >-
                Requests charged the fixed estimate because OpenAI reported no
                usage.
            inputTokens:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            outputTokens:
              type: integer
              minimum: 0
              maximum: 9007199254740991
          required:
            - costMicroUsd
            - requests
            - estimatedRequests
            - inputTokens
            - outputTokens
        week:
          type: object
          properties:
            startsAt:
              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))$
            endsAt:
              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))$
            activePeople:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            peopleAtWeeklyLimit:
              type: integer
              minimum: 0
              maximum: 9007199254740991
          required:
            - startsAt
            - endsAt
            - activePeople
            - peopleAtWeeklyLimit
        daily:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              membersMicroUsd:
                type: integer
                minimum: 0
                maximum: 9007199254740991
              guestsMicroUsd:
                type: integer
                minimum: 0
                maximum: 9007199254740991
              requests:
                type: integer
                minimum: 0
                maximum: 9007199254740991
            required:
              - date
              - membersMicroUsd
              - guestsMicroUsd
              - requests
        organizations:
          type: array
          items:
            type: object
            properties:
              costMicroUsd:
                type: integer
                minimum: 0
                maximum: 9007199254740991
              requests:
                type: integer
                minimum: 0
                maximum: 9007199254740991
              estimatedRequests:
                type: integer
                minimum: 0
                maximum: 9007199254740991
                description: >-
                  Requests charged the fixed estimate because OpenAI reported no
                  usage.
              inputTokens:
                type: integer
                minimum: 0
                maximum: 9007199254740991
              outputTokens:
                type: integer
                minimum: 0
                maximum: 9007199254740991
              id:
                type: string
              name:
                type: string
              slug:
                anyOf:
                  - type: string
                  - type: 'null'
              enrolled:
                type: boolean
                description: >-
                  Whether the organization's members are offered free Auto by
                  the rollout.
              subscribed:
                type: boolean
                description: >-
                  Pays for OpenWork Models, so its members use paid Models
                  rather than free Auto.
              memberCount:
                type: integer
                minimum: 0
                maximum: 9007199254740991
              activePeople:
                type: integer
                minimum: 0
                maximum: 9007199254740991
              peopleAtWeeklyLimit:
                type: integer
                minimum: 0
                maximum: 9007199254740991
                description: >-
                  People in this organization who used free Auto this week and
                  have reached their weekly allowance.
              lastUsedAt:
                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'
            required:
              - costMicroUsd
              - requests
              - estimatedRequests
              - inputTokens
              - outputTokens
              - id
              - name
              - slug
              - enrolled
              - subscribed
              - memberCount
              - activePeople
              - peopleAtWeeklyLimit
              - lastUsedAt
        otherOrganizations:
          anyOf:
            - type: object
              properties:
                costMicroUsd:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                requests:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                estimatedRequests:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                  description: >-
                    Requests charged the fixed estimate because OpenAI reported
                    no usage.
                inputTokens:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                outputTokens:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                organizations:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
              required:
                - costMicroUsd
                - requests
                - estimatedRequests
                - inputTokens
                - outputTokens
                - organizations
            - type: 'null'
          description: >-
            Organizations past the listed limit, summed so the table always adds
            up to the members total.
      required:
        - generatedAt
        - range
        - settings
        - totals
        - members
        - guests
        - week
        - daily
        - organizations
        - otherOrganizations
    InvalidRequestError:
      type: object
      properties:
        error:
          type: string
          const: invalid_request
        message:
          type: string
        details:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
            required:
              - message
            additionalProperties: {}
        capability:
          type: string
      required:
        - error
        - details
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: session-token
      description: >-
        Session token passed as `Authorization: Bearer <session-token>` for
        user-authenticated Den routes.
    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`.

````