> ## 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. # Create an active OpenWork Cloud Automation > Den schedules Automations and keeps durable run history. A Desktop Automation runs on any of the owner's connected desktops (one pinned to a workspace, on a desktop that has it); a Cloud Automation runs in OpenWork Cloud. If no desktop runner is connected when a desktop occurrence is due, that occurrence is recorded as missed. Creation makes an Automation active immediately and uses the owner's current OpenWork Connect integrations. Deactivation stops future runs but does not cancel a run already in progress. This is the Web and Cloud Chat creation surface. Placement is fixed to OpenWork Cloud and the Automation can wake a stopped Cloud container without a desktop. Create only when the person explicitly asks to create or schedule it; there is no draft step. ## OpenAPI ````yaml https://api.openworklabs.com/openapi.json?public=1 post /v1/cloud-automations 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 8863aab 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: 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: 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/cloud-automations: post: tags: - Automations summary: Create an active OpenWork Cloud Automation description: >- Den schedules Automations and keeps durable run history. A Desktop Automation runs on any of the owner's connected desktops (one pinned to a workspace, on a desktop that has it); a Cloud Automation runs in OpenWork Cloud. If no desktop runner is connected when a desktop occurrence is due, that occurrence is recorded as missed. Creation makes an Automation active immediately and uses the owner's current OpenWork Connect integrations. Deactivation stops future runs but does not cancel a run already in progress. This is the Web and Cloud Chat creation surface. Placement is fixed to OpenWork Cloud and the Automation can wake a stopped Cloud container without a desktop. Create only when the person explicitly asks to create or schedule it; there is no draft step. operationId: createCloudAutomation requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 120 schedule: oneOf: - type: object properties: kind: type: string const: once timezone: type: string minLength: 1 maxLength: 120 at: type: integer minimum: 0 maximum: 9007199254740991 required: - kind - timezone - at - type: object properties: kind: type: string const: daily timezone: type: string minLength: 1 maxLength: 120 hour: type: integer minimum: 0 maximum: 23 minute: type: integer minimum: 0 maximum: 59 required: - kind - timezone - hour - minute - type: object properties: kind: type: string const: weekly timezone: type: string minLength: 1 maxLength: 120 daysOfWeek: minItems: 1 maxItems: 7 type: array items: type: integer minimum: 0 maximum: 6 hour: type: integer minimum: 0 maximum: 23 minute: type: integer minimum: 0 maximum: 59 required: - kind - timezone - daysOfWeek - hour - minute - type: object properties: kind: type: string const: interval timezone: type: string minLength: 1 maxLength: 120 everyHours: type: integer minimum: 1 maximum: 24 daysOfWeek: minItems: 1 maxItems: 7 type: array items: type: integer minimum: 0 maximum: 6 startHour: default: 0 type: integer minimum: 0 maximum: 23 endHour: default: 24 type: integer minimum: 1 maximum: 24 required: - kind - timezone - everyHours description: >- Every everyHours hours on the hour, counted from startHour on each listed day (0 = Sunday) and stopping before endHour, in timezone. Needs the organization's every-few-hours schedules. - type: object properties: kind: type: string const: calendar timezone: type: string minLength: 1 maxLength: 120 edge: type: string enum: - start - end offsetMinutes: type: integer minimum: -120 maximum: 120 rule: default: withExternalAttendees: false type: object properties: withExternalAttendees: default: false type: boolean titleIncludes: type: string minLength: 1 maxLength: 120 additionalProperties: false required: - kind - timezone - edge - offsetMinutes description: >- Runs offsetMinutes (negative is before) from the start or end of each meeting on the owner's primary Google Calendar: timed meetings they accepted or organize, with someone else invited. Cloud Automations only; needs Google Calendar connected and the organization's before-and-after-meeting Automations. action: oneOf: - type: object properties: kind: type: string const: agent instructions: type: string minLength: 1 maxLength: 100000 model: type: object properties: providerId: type: string minLength: 1 maxLength: 160 modelId: type: string minLength: 1 maxLength: 160 variant: anyOf: - type: string minLength: 1 maxLength: 60 - type: 'null' required: - providerId - modelId required: - kind - instructions - model additionalProperties: false - type: object properties: kind: type: string const: saved_script script: type: object properties: pluginId: type: string minLength: 1 maxLength: 160 configObjectId: type: string minLength: 1 maxLength: 160 configObjectVersionId: type: string minLength: 1 maxLength: 160 required: - pluginId - configObjectId - configObjectVersionId additionalProperties: false input: {} required: - kind - script additionalProperties: false required: - name - schedule - action additionalProperties: false responses: '201': description: Active Cloud Automation created. content: application/json: schema: $ref: '#/components/schemas/AutomationDetail' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/InvalidRequestError' '401': description: Sign-in required. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: OpenWork Web access is required. content: application/json: schema: $ref: '#/components/schemas/AutomationOpenWorkWebAccessRequiredError' '409': description: Cloud runtime or model access is unavailable. content: application/json: schema: $ref: '#/components/schemas/InvalidRequestError' security: - denApiKey: [] - bearerAuth: [] components: schemas: AutomationDetail: type: object properties: automation: $ref: '#/components/schemas/Automation' revision: $ref: '#/components/schemas/AutomationRevision' latestRun: anyOf: - $ref: '#/components/schemas/AutomationRun' - type: 'null' required: - automation - revision - latestRun 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 AutomationOpenWorkWebAccessRequiredError: type: object properties: error: type: string const: openwork_web_access_required message: type: string required: - error - message Automation: type: object properties: id: type: string minLength: 1 maxLength: 160 organizationId: type: string minLength: 1 maxLength: 160 ownerMemberId: type: string minLength: 1 maxLength: 160 name: type: string minLength: 1 maxLength: 120 state: $ref: '#/components/schemas/AutomationState' currentRevisionId: type: string minLength: 1 maxLength: 160 nextDueAt: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' latestRunAt: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' latestSuccessfulRunId: anyOf: - type: string minLength: 1 maxLength: 160 - type: 'null' latestSuccessfulResult: {} needsAttentionReason: anyOf: - $ref: '#/components/schemas/AutomationNeedsAttentionReason' - type: 'null' createdAt: type: integer minimum: 0 maximum: 9007199254740991 updatedAt: type: integer minimum: 0 maximum: 9007199254740991 archivedAt: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' required: - id - organizationId - ownerMemberId - name - state - currentRevisionId - nextDueAt - latestRunAt - needsAttentionReason - createdAt - updatedAt - archivedAt AutomationRevision: type: object properties: id: type: string minLength: 1 maxLength: 160 automationId: type: string minLength: 1 maxLength: 160 version: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 instructions: type: string minLength: 1 maxLength: 100000 schedule: oneOf: - type: object properties: kind: type: string const: once timezone: type: string minLength: 1 maxLength: 120 at: type: integer minimum: 0 maximum: 9007199254740991 required: - kind - timezone - at - type: object properties: kind: type: string const: daily timezone: type: string minLength: 1 maxLength: 120 hour: type: integer minimum: 0 maximum: 23 minute: type: integer minimum: 0 maximum: 59 required: - kind - timezone - hour - minute - type: object properties: kind: type: string const: weekly timezone: type: string minLength: 1 maxLength: 120 daysOfWeek: minItems: 1 maxItems: 7 type: array items: type: integer minimum: 0 maximum: 6 hour: type: integer minimum: 0 maximum: 23 minute: type: integer minimum: 0 maximum: 59 required: - kind - timezone - daysOfWeek - hour - minute - type: object properties: kind: type: string const: interval timezone: type: string minLength: 1 maxLength: 120 everyHours: type: integer minimum: 1 maximum: 24 daysOfWeek: minItems: 1 maxItems: 7 type: array items: type: integer minimum: 0 maximum: 6 startHour: default: 0 type: integer minimum: 0 maximum: 23 endHour: default: 24 type: integer minimum: 1 maximum: 24 required: - kind - timezone - everyHours description: >- Every everyHours hours on the hour, counted from startHour on each listed day (0 = Sunday) and stopping before endHour, in timezone. Needs the organization's every-few-hours schedules. - type: object properties: kind: type: string const: calendar timezone: type: string minLength: 1 maxLength: 120 edge: type: string enum: - start - end offsetMinutes: type: integer minimum: -120 maximum: 120 rule: default: withExternalAttendees: false type: object properties: withExternalAttendees: default: false type: boolean titleIncludes: type: string minLength: 1 maxLength: 120 additionalProperties: false required: - kind - timezone - edge - offsetMinutes description: >- Runs offsetMinutes (negative is before) from the start or end of each meeting on the owner's primary Google Calendar: timed meetings they accepted or organize, with someone else invited. Cloud Automations only; needs Google Calendar connected and the organization's before-and-after-meeting Automations. model: type: object properties: providerId: type: string minLength: 1 maxLength: 160 modelId: type: string minLength: 1 maxLength: 160 variant: anyOf: - type: string minLength: 1 maxLength: 60 - type: 'null' required: - providerId - modelId action: oneOf: - type: object properties: kind: type: string const: agent instructions: type: string minLength: 1 maxLength: 100000 model: type: object properties: providerId: type: string minLength: 1 maxLength: 160 modelId: type: string minLength: 1 maxLength: 160 variant: anyOf: - type: string minLength: 1 maxLength: 60 - type: 'null' required: - providerId - modelId required: - kind - instructions - model additionalProperties: false - type: object properties: kind: type: string const: saved_script script: type: object properties: pluginId: type: string minLength: 1 maxLength: 160 configObjectId: type: string minLength: 1 maxLength: 160 configObjectVersionId: type: string minLength: 1 maxLength: 160 required: - pluginId - configObjectId - configObjectVersionId additionalProperties: false input: {} required: - kind - script additionalProperties: false executionTarget: type: string enum: - desktop - cloud workspaceId: anyOf: - type: string minLength: 1 maxLength: 240 - type: 'null' maximumRuntimeMs: type: integer minimum: 10000 maximum: 3600000 digest: type: string minLength: 16 maxLength: 128 createdAt: type: integer minimum: 0 maximum: 9007199254740991 required: - id - automationId - version - instructions - schedule - model - maximumRuntimeMs - digest - createdAt AutomationRun: type: object properties: id: type: string minLength: 1 maxLength: 160 automationId: type: string minLength: 1 maxLength: 160 revisionId: type: string minLength: 1 maxLength: 160 trigger: $ref: '#/components/schemas/AutomationRunTrigger' scheduledFor: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' idempotencyKey: type: string minLength: 1 maxLength: 512 status: $ref: '#/components/schemas/AutomationRunStatus' leaseOwner: anyOf: - type: string minLength: 1 maxLength: 240 - type: 'null' leaseExpiresAt: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' heartbeatAt: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' attemptCount: type: integer minimum: 0 maximum: 2 executionTarget: type: string enum: - desktop - cloud executionThread: anyOf: - $ref: '#/components/schemas/AutomationExecutionThread' - type: 'null' providerId: type: string minLength: 1 maxLength: 160 modelId: type: string minLength: 1 maxLength: 160 modelVariant: default: null anyOf: - type: string minLength: 1 maxLength: 60 - type: 'null' startedAt: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' finishedAt: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' error: anyOf: - $ref: '#/components/schemas/AutomationError' - type: 'null' resultSummary: anyOf: - type: string maxLength: 20000 - type: 'null' codemodeReceiptId: anyOf: - type: string minLength: 1 maxLength: 160 - type: 'null' validatedResult: {} triggerContext: anyOf: - $ref: '#/components/schemas/AutomationRunTriggerContext' - type: 'null' usage: $ref: '#/components/schemas/AutomationUsage' createdAt: type: integer minimum: 0 maximum: 9007199254740991 updatedAt: type: integer minimum: 0 maximum: 9007199254740991 required: - id - automationId - revisionId - trigger - scheduledFor - idempotencyKey - status - leaseOwner - leaseExpiresAt - heartbeatAt - attemptCount - executionTarget - executionThread - providerId - modelId - startedAt - finishedAt - error - resultSummary - usage - createdAt - updatedAt AutomationState: type: string enum: - active - inactive - needs_attention - archived AutomationNeedsAttentionReason: type: object properties: code: type: string enum: - owner_membership_lost - model_access_lost - provider_unavailable - connect_access_unavailable - openwork_web_access_required - execution_runtime_unavailable message: type: string minLength: 1 maxLength: 2000 occurredAt: type: integer minimum: 0 maximum: 9007199254740991 required: - code - message - occurredAt AutomationRunTrigger: type: string enum: - scheduled - recovery - manual AutomationRunStatus: type: string enum: - queued - claimed - running - succeeded - failed - cancelled - skipped AutomationExecutionThread: type: object properties: id: type: string minLength: 1 maxLength: 160 threadKind: type: string const: automation executionLocation: type: string enum: - desktop - cloud automationId: type: string minLength: 1 maxLength: 160 automationRunId: type: string minLength: 1 maxLength: 160 engineKind: type: string minLength: 1 maxLength: 160 nativeThreadId: anyOf: - type: string minLength: 1 maxLength: 160 - type: 'null' workspaceId: anyOf: - type: string minLength: 1 maxLength: 160 - type: 'null' required: - id - threadKind - executionLocation - automationId - automationRunId - engineKind AutomationError: type: object properties: code: type: string enum: - owner_membership_lost - model_access_lost - provider_unavailable - connect_access_unavailable - openwork_web_access_required - execution_runtime_unavailable - execution_failed - execution_timed_out - runner_unavailable - cancelled - lease_lost - internal_error message: type: string minLength: 1 maxLength: 2000 retryable: type: boolean required: - code - message - retryable AutomationRunTriggerContext: oneOf: - $ref: '#/components/schemas/AutomationMeetingContext' AutomationUsage: type: object properties: inputTokens: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' outputTokens: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' costMicros: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' required: - inputTokens - outputTokens - costMicros AutomationMeetingContext: type: object properties: kind: type: string const: calendar_meeting eventId: type: string minLength: 1 maxLength: 1024 title: anyOf: - type: string maxLength: 300 - type: 'null' start: type: integer minimum: 0 maximum: 9007199254740991 end: type: integer minimum: 0 maximum: 9007199254740991 attendeeDomains: maxItems: 50 type: array items: type: string maxLength: 253 externalAttendees: type: integer minimum: 0 maximum: 9007199254740991 link: anyOf: - type: string maxLength: 2048 - type: 'null' required: - kind - eventId - title - start - end - attendeeDomains - externalAttendees - link 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.