> ## 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 own Gateway usage by UTC day > The caller's own AI Gateway usage, by model, over the last `days` UTC calendar days including today (default 30, 1-366): the same report as GET /v1/inference-providers/usage with groupBy=model, scoped to the caller's membership and without organization filter options. Reads raw request logs and retained rollups; cost is the stored approximate cost in integer micro-USD, never repriced. tokenMix lists, per model series, the input (excluding cache), output, cache read and cache write tokens of requests that reported both input and output tokens. models lists the Gateway models the caller can use now, with the listed price from the model's catalog config (USD per 1M tokens) or null when it has none. Any member can read their own usage; no Gateway permission is needed. Requires enabled Gateway management. ## OpenAPI ````yaml https://api.openworklabs.com/openapi.json?public=1 get /v1/gateway/usage/me 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 ` 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 c71d566 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/gateway/usage/me: get: tags: - Gateway Usage Limits summary: Read own Gateway usage by UTC day description: >- The caller's own AI Gateway usage, by model, over the last `days` UTC calendar days including today (default 30, 1-366): the same report as GET /v1/inference-providers/usage with groupBy=model, scoped to the caller's membership and without organization filter options. Reads raw request logs and retained rollups; cost is the stored approximate cost in integer micro-USD, never repriced. tokenMix lists, per model series, the input (excluding cache), output, cache read and cache write tokens of requests that reported both input and output tokens. models lists the Gateway models the caller can use now, with the listed price from the model's catalog config (USD per 1M tokens) or null when it has none. Any member can read their own usage; no Gateway permission is needed. Requires enabled Gateway management. operationId: getV1GatewayUsageMe parameters: - in: query name: days schema: default: '30' type: string maxLength: 3 pattern: ^[1-9]\d*$ responses: '200': description: Own Gateway usage content: application/json: schema: type: object properties: usage: type: object properties: groupBy: type: string enum: - model - team - person days: type: integer minimum: 1 maximum: 366 from: type: string format: date 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])))$ to: type: string format: date 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])))$ timezone: type: string const: UTC emptyReason: type: string const: no_teams requestCount: type: integer minimum: 0 maximum: 9007199254740991 uncountableRequests: type: object properties: ok: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' upstream_error: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' upstream_unreachable: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' client_aborted: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' rejected: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' required: - ok - upstream_error - upstream_unreachable - client_aborted - rejected totalTokens: type: integer minimum: 0 maximum: 9007199254740991 unreportedRequests: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' totalCostMicroUsd: type: integer minimum: 0 maximum: 9007199254740991 unpricedRequests: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' series: type: array items: type: object properties: id: type: string minLength: 1 label: type: string minLength: 1 required: - id - label daily: type: array items: type: object properties: date: type: string format: date 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])))$ totalTokens: type: integer minimum: 0 maximum: 9007199254740991 values: type: object propertyNames: type: string additionalProperties: type: integer minimum: 0 maximum: 9007199254740991 totalCostMicroUsd: type: integer minimum: 0 maximum: 9007199254740991 costValues: type: object propertyNames: type: string additionalProperties: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' required: - date - totalTokens - values - totalCostMicroUsd - costValues filterOptions: type: array items: type: object properties: id: type: string minLength: 1 label: type: string minLength: 1 required: - id - label required: - groupBy - days - from - to - timezone - totalTokens - unreportedRequests - totalCostMicroUsd - unpricedRequests - series - daily - filterOptions tokenMix: type: array items: type: object properties: seriesId: type: string minLength: 1 measuredRequests: type: integer minimum: 0 maximum: 9007199254740991 uncachedInputTokens: type: integer minimum: 0 maximum: 9007199254740991 outputTokens: type: integer minimum: 0 maximum: 9007199254740991 cacheReadTokens: type: integer minimum: 0 maximum: 9007199254740991 cacheWriteTokens: type: integer minimum: 0 maximum: 9007199254740991 required: - seriesId - measuredRequests - uncachedInputTokens - outputTokens - cacheReadTokens - cacheWriteTokens models: type: array items: type: object properties: id: type: string minLength: 1 name: type: string minLength: 1 providerName: type: string minLength: 1 providerId: type: string minLength: 1 upstreamModelId: type: string minLength: 1 seriesId: type: string minLength: 1 price: anyOf: - type: object properties: input: type: number minimum: 0 maximum: 1000000 output: type: number minimum: 0 maximum: 1000000 cacheRead: anyOf: - type: number minimum: 0 maximum: 1000000 - type: 'null' cacheWrite: anyOf: - type: number minimum: 0 maximum: 1000000 - type: 'null' contextTiers: type: array items: type: object properties: input: type: number minimum: 0 maximum: 1000000 output: type: number minimum: 0 maximum: 1000000 cacheRead: anyOf: - type: number minimum: 0 maximum: 1000000 - type: 'null' cacheWrite: anyOf: - type: number minimum: 0 maximum: 1000000 - type: 'null' above: type: integer minimum: 0 maximum: 9007199254740991 required: - input - output - cacheRead - cacheWrite - above required: - input - output - cacheRead - cacheWrite - contextTiers - type: 'null' required: - id - name - providerName - providerId - upstreamModelId - seriesId - price required: - usage - tokenMix - models '400': description: Invalid query content: application/json: schema: $ref: '#/components/schemas/InvalidRequestError' '401': description: Sign-in required content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: Gateway management disabled content: application/json: schema: anyOf: - $ref: '#/components/schemas/ForbiddenError' - type: object properties: error: type: string const: gateway_not_enabled message: type: string required: - error - message '422': description: Usage cannot be represented safely content: application/json: schema: type: object properties: error: type: string message: type: string required: - error - message security: - denApiKey: [] - bearerAuth: [] components: schemas: 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: type: - string - 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: 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 ` 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.