> ## 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. # Change the settings for a team's members' agents > Changes any subset of how members' agents work for one team's members, with the same body and the same checks as `PUT /v1/org/workbot-settings/proactive`: policy fields, `sources` (only the organization's own connections, each where it can serve; an MCP only with reviewed read tools unless workbotAgentBrief is on; a core source's default must stay allowed), `brief` (400 without workbotAgentBrief), `responsibilities` and `instructions`. The change is merged onto the team's own policy. A team that followed the organization starts from the organization's policy, sources, brief and template as they are now, and this first save makes that copy the team's own: from then on it no longer follows the organization's changes. A change to responsibilities or instructions adds one to the team's template `version`. The team's members follow it from their next check, including when agents are off for everyone and on for this team; a member on several teams whose own policies differ follows the organization's. Members' own choices are kept. To follow the organization again, send `agent: { inherit: true }` to `PUT /v1/org/workbot-settings/teams/{teamId}`. Returns the team's policy with `inherit: false`. Requires the Workbot settings per team and workbotProactive features, Workbot on this deployment and Manage OpenWork Models. ## OpenAPI ````yaml https://api.openworklabs.com/openapi.json?public=1 put /v1/org/workbot-settings/teams/{teamId}/agent 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 6477edf 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: 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/org/workbot-settings/teams/{teamId}/agent: put: tags: - Organizations summary: Change the settings for a team's members' agents description: >- Changes any subset of how members' agents work for one team's members, with the same body and the same checks as `PUT /v1/org/workbot-settings/proactive`: policy fields, `sources` (only the organization's own connections, each where it can serve; an MCP only with reviewed read tools unless workbotAgentBrief is on; a core source's default must stay allowed), `brief` (400 without workbotAgentBrief), `responsibilities` and `instructions`. The change is merged onto the team's own policy. A team that followed the organization starts from the organization's policy, sources, brief and template as they are now, and this first save makes that copy the team's own: from then on it no longer follows the organization's changes. A change to responsibilities or instructions adds one to the team's template `version`. The team's members follow it from their next check, including when agents are off for everyone and on for this team; a member on several teams whose own policies differ follows the organization's. Members' own choices are kept. To follow the organization again, send `agent: { inherit: true }` to `PUT /v1/org/workbot-settings/teams/{teamId}`. Returns the team's policy with `inherit: false`. Requires the Workbot settings per team and workbotProactive features, Workbot on this deployment and Manage OpenWork Models. operationId: putV1OrgWorkbotSettingsTeamsByTeamIdAgent parameters: - in: path name: teamId schema: format: typeid type: string minLength: 30 maxLength: 30 required: true description: Den TypeID with 'tem_' prefix and a 26-character base32 suffix. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WorkbotProactiveSettingsInput' responses: '200': description: The team's agent settings saved. content: application/json: schema: $ref: '#/components/schemas/WorkbotTeamAgentSettings' '400': description: The request was invalid, or the workday would end before it starts. content: application/json: schema: anyOf: - $ref: '#/components/schemas/WorkbotProactiveInvalidHoursError' - $ref: '#/components/schemas/InvalidRequestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: The caller lacks the Manage OpenWork Models permission. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: >- The organization or team was not found, or Workbot settings per team, members' agents or Workbot are off. content: application/json: schema: anyOf: - type: object properties: error: type: string const: feature_disabled feature: type: string required: - error - feature - $ref: '#/components/schemas/NotFoundError' security: - denApiKey: [] - bearerAuth: [] components: schemas: WorkbotProactiveSettingsInput: type: object properties: enabled: type: boolean leadMinutes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 workingDays: type: string enum: - weekdays - everyday startHour: type: integer minimum: 0 maximum: 23 endHour: type: integer minimum: 1 maximum: 24 dailyCap: type: integer minimum: 1 maximum: 10 membersStart: type: string enum: - opted_in - opted_out destination: anyOf: - type: string enum: - workbot_dm - type: 'null' sources: type: object properties: calendar: type: string enum: - everyone - members - 'off' email: type: string enum: - everyone - members - 'off' chat: type: string enum: - everyone - members - 'off' coreConnections: type: object properties: calendar: anyOf: - maxItems: 2000 type: array items: type: string minLength: 1 maxLength: 64 - type: 'null' email: anyOf: - maxItems: 2000 type: array items: type: string minLength: 1 maxLength: 64 - type: 'null' chat: anyOf: - maxItems: 2000 type: array items: type: string minLength: 1 maxLength: 64 - type: 'null' additionalProperties: false coreDefaults: type: object properties: calendar: anyOf: - type: string minLength: 1 maxLength: 64 - type: 'null' email: anyOf: - type: string minLength: 1 maxLength: 64 - type: 'null' chat: anyOf: - type: string minLength: 1 maxLength: 64 - type: 'null' additionalProperties: false otherConnections: anyOf: - maxItems: 2000 type: array items: type: string minLength: 1 maxLength: 64 - type: 'null' connections: type: object propertyNames: type: string minLength: 1 maxLength: 64 additionalProperties: anyOf: - type: string enum: - everyone - members - 'off' - type: 'null' toolOverrides: type: object propertyNames: type: string minLength: 1 maxLength: 64 additionalProperties: anyOf: - type: object propertyNames: type: string minLength: 1 maxLength: 255 additionalProperties: anyOf: - type: string enum: - allow - deny - type: 'null' - type: 'null' additionalProperties: false brief: type: object properties: checkEveryHours: anyOf: - type: number const: 1 - type: number const: 2 - type: number const: 3 - type: number const: 4 dailyCap: type: integer minimum: 1 maximum: 10 extraChecksPerDay: type: integer minimum: 0 maximum: 6 text: type: string maxLength: 2000 additionalProperties: false responsibilities: type: object properties: morning_brief: type: boolean meeting_prep: type: boolean calendar_changes: type: boolean waiting_on_you: type: boolean instructions: type: string maxLength: 600 additionalProperties: false WorkbotTeamAgentSettings: type: object properties: settings: type: object properties: enabled: type: boolean leadMinutes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 workingDays: type: string enum: - weekdays - everyday startHour: type: integer minimum: 0 maximum: 23 endHour: type: integer minimum: 1 maximum: 24 dailyCap: type: integer minimum: 1 maximum: 10 membersStart: type: string enum: - opted_in - opted_out destination: anyOf: - type: string enum: - workbot_dm - type: 'null' sources: type: object properties: calendar: type: string enum: - everyone - members - 'off' email: type: string enum: - everyone - members - 'off' chat: type: string enum: - everyone - members - 'off' coreConnections: type: object properties: calendar: maxItems: 2000 type: array items: type: string minLength: 1 maxLength: 64 email: maxItems: 2000 type: array items: type: string minLength: 1 maxLength: 64 chat: maxItems: 2000 type: array items: type: string minLength: 1 maxLength: 64 coreDefaults: type: object properties: calendar: type: string minLength: 1 maxLength: 64 email: type: string minLength: 1 maxLength: 64 chat: type: string minLength: 1 maxLength: 64 otherConnections: maxItems: 2000 type: array items: type: string minLength: 1 maxLength: 64 connections: type: object propertyNames: type: string minLength: 1 maxLength: 64 additionalProperties: type: string enum: - everyone - members - 'off' toolOverrides: type: object propertyNames: type: string minLength: 1 maxLength: 64 additionalProperties: type: object propertyNames: type: string minLength: 1 maxLength: 255 additionalProperties: type: string enum: - allow - deny required: - calendar - email - chat - connections brief: type: object properties: checkEveryHours: anyOf: - type: number const: 1 - type: number const: 2 - type: number const: 3 - type: number const: 4 dailyCap: type: integer minimum: 1 maximum: 10 extraChecksPerDay: type: integer minimum: 0 maximum: 6 text: type: string maxLength: 2000 required: - enabled - leadMinutes - workingDays - startHour - endHour - dailyCap - membersStart - destination - sources template: type: object properties: responsibilities: type: object properties: morning_brief: type: boolean meeting_prep: type: boolean calendar_changes: type: boolean waiting_on_you: type: boolean required: - morning_brief - meeting_prep - calendar_changes - waiting_on_you instructions: type: string maxLength: 600 versionId: type: - string - 'null' version: type: integer minimum: 1 maximum: 9007199254740991 required: - responsibilities - instructions - versionId - version slackReady: type: boolean runnerReady: type: boolean sourceConnections: anyOf: - type: object properties: calendar: type: array items: type: object properties: id: type: string name: type: string url: type: string connectedMembers: default: null anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' required: - id - name - url email: type: array items: type: object properties: id: type: string name: type: string url: type: string connectedMembers: default: null anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' required: - id - name - url chat: type: array items: type: object properties: id: type: string name: type: string url: type: string connectedMembers: default: null anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' required: - id - name - url other: type: array items: type: object properties: id: type: string name: type: string url: type: string native: type: boolean policy: type: string enum: - everyone - members - 'off' required: - id - name - url all: type: array items: type: object properties: id: type: string name: type: string url: type: string native: type: boolean slots: type: array items: type: string enum: - calendar - email - chat - other connectedMembers: default: null anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' required: - id - name - url - native - slots defaults: default: calendar: null email: null chat: null type: object properties: calendar: type: - string - 'null' email: type: - string - 'null' chat: type: - string - 'null' required: - calendar - email - chat required: - calendar - email - chat - other - all - type: 'null' brief: type: object properties: checkEveryHours: anyOf: - type: number const: 1 - type: number const: 2 - type: number const: 3 - type: number const: 4 dailyCap: type: integer minimum: 1 maximum: 10 extraChecksPerDay: type: integer minimum: 0 maximum: 6 text: type: string maxLength: 2000 defaultText: type: string carriedOver: type: array items: type: string enum: - checkEveryHours - dailyCap - extraChecksPerDay - text required: - checkEveryHours - dailyCap - extraChecksPerDay - text - defaultText - carriedOver inherit: type: boolean required: - settings - template - slackReady - runnerReady - sourceConnections - inherit WorkbotProactiveInvalidHoursError: type: object properties: error: type: string const: invalid_working_hours message: type: string required: - error - message 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 NotFoundError: type: object properties: error: 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.