> ## 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. # Report this desktop and how its computer use is doing > Sent by the signed-in desktop app on launch, when something changes and every few minutes. Creates or refreshes this desktop in the caller's list, records what changed (app update, computer use needing setup, the computer agents use) and does the same for VMs the desktop is configured to reach. Names, versions and readiness only: no file paths, window titles or screen content. `installId` is the id the desktop registers its runner with, so the same computer is one entry. A desktop that was disconnected from the organization is answered 403 computer_disconnected and its entry is left as it was, unless the report comes with a sign-in made after the disconnect, which connects it again. Needs the Devices feature. ## OpenAPI ````yaml https://api.openworklabs.com/openapi.json?public=1 put /v1/remote-devices/this-computer 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 1d1e40f 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: 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: 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/remote-devices/this-computer: put: tags: - Devices summary: Report this desktop and how its computer use is doing description: >- Sent by the signed-in desktop app on launch, when something changes and every few minutes. Creates or refreshes this desktop in the caller's list, records what changed (app update, computer use needing setup, the computer agents use) and does the same for VMs the desktop is configured to reach. Names, versions and readiness only: no file paths, window titles or screen content. `installId` is the id the desktop registers its runner with, so the same computer is one entry. A desktop that was disconnected from the organization is answered 403 computer_disconnected and its entry is left as it was, unless the report comes with a sign-in made after the disconnect, which connects it again. Needs the Devices feature. operationId: putV1RemoteDevicesThisComputer requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RemoteDeviceDesktopReport' responses: '200': description: This desktop as listed, and when to report again. content: application/json: schema: $ref: '#/components/schemas/RemoteDeviceDesktopReportResponse' '400': description: The report was invalid. content: application/json: schema: $ref: '#/components/schemas/InvalidRequestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: >- This computer was disconnected from the organization. Signing in on it again connects it. content: application/json: schema: type: object properties: error: type: string const: computer_disconnected message: type: string required: - error - message '404': description: The organization was not found, or Devices is off for it. content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '429': description: >- Too many reports from this member; Retry-After says when to send again. content: application/json: schema: type: object properties: error: type: string const: rate_limited required: - error security: - denApiKey: [] - bearerAuth: [] components: schemas: RemoteDeviceDesktopReport: type: object properties: installId: type: string minLength: 8 maxLength: 160 label: type: string minLength: 1 maxLength: 80 platform: type: string enum: - darwin - win32 - linux appVersion: type: string minLength: 1 maxLength: 80 osVersion: default: null anyOf: - type: string maxLength: 80 - type: 'null' arch: default: null anyOf: - type: string maxLength: 32 - type: 'null' computerUse: default: null anyOf: - type: object properties: enabled: type: boolean remoteEnabled: type: boolean selectedId: anyOf: - type: string maxLength: 64 - type: 'null' computers: maxItems: 12 type: array items: type: object properties: id: type: string minLength: 1 maxLength: 64 label: type: string minLength: 1 maxLength: 80 placement: type: string enum: - local - remote readiness: anyOf: - type: string enum: - ready - setup-required - unsupported - unavailable - type: 'null' detail: anyOf: - type: string maxLength: 300 - type: 'null' provider: default: null anyOf: - type: string enum: - freestyle - daytona - type: 'null' externalId: default: null anyOf: - type: string minLength: 1 maxLength: 160 - type: 'null' required: - id - label - placement - readiness - detail additionalProperties: false permissions: default: null anyOf: - type: object properties: accessibility: type: boolean screenRecording: type: boolean required: - accessibility - screenRecording additionalProperties: false - type: 'null' required: - enabled - remoteEnabled - selectedId - computers additionalProperties: false - type: 'null' required: - installId - label - platform - appVersion additionalProperties: false RemoteDeviceDesktopReportResponse: type: object properties: device: $ref: '#/components/schemas/RemoteDevice' reportAfterSeconds: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 required: - device - reportAfterSeconds 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 NotFoundError: type: object properties: error: type: string message: type: string required: - error RemoteDevice: type: object properties: id: type: string kind: type: string enum: - desktop - vm provider: type: string enum: - openwork_desktop - workbot - freestyle - daytona - mac_host - other source: type: string enum: - desktop_app - workbot - manual platform: anyOf: - type: string enum: - darwin - win32 - linux - type: 'null' label: type: string access: type: string enum: - mine - shared availability: type: string enum: - online - paused - needs_setup - offline - unknown state: type: string enum: - ready - paused - setup_required - unavailable - unknown statusDetail: type: - string - 'null' lastSeenAt: 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ - type: 'null' createdAt: 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ appVersion: type: - string - 'null' computerId: type: - string - 'null' workbotChat: type: - string - 'null' canRename: type: boolean canRemove: type: boolean disconnectedAt: default: null 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ - type: 'null' canDisconnect: default: false type: boolean required: - id - kind - provider - source - platform - label - access - availability - state - statusDetail - lastSeenAt - createdAt - appVersion - computerId - workbotChat - canRename - canRemove 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.