> ## 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. # Ask a person to enter the API key of an existing MCP connection > Shows the person a private field in OpenWork for an existing API-key connection, so the key never passes through you. Use it to finish a connection still waiting for its shared key, to let the caller add or replace their own key (scope personal), or to let an owner or admin replace each person's own key with one shared key (scope shared on a personal-key connection; its ID and access stay, and nothing changes until they save a key that works). Changes nothing by itself. ## OpenAPI ````yaml /openapi.json post /v1/mcp-connections/{connectionId}/credential-prompt 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: 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: - 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: 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/mcp-connections/{connectionId}/credential-prompt: post: tags: - Capability Sources summary: Ask a person to enter the API key of an existing MCP connection description: >- Shows the person a private field in OpenWork for an existing API-key connection, so the key never passes through you. Use it to finish a connection still waiting for its shared key, to let the caller add or replace their own key (scope personal), or to let an owner or admin replace each person's own key with one shared key (scope shared on a personal-key connection; its ID and access stay, and nothing changes until they save a key that works). Changes nothing by itself. operationId: postV1McpConnectionsByConnectionIdCredentialPrompt parameters: - in: path name: connectionId schema: format: typeid type: string minLength: 30 maxLength: 30 required: true description: Den TypeID with 'emc_' prefix and a 26-character base32 suffix. requestBody: required: true content: application/json: schema: type: object properties: scope: type: string enum: - shared - personal additionalProperties: false responses: '200': description: A private field is shown to the person. content: application/json: schema: $ref: >- #/components/schemas/ExternalMcpConnectionCredentialPromptResponse '400': description: This connection does not take this kind of key. content: application/json: schema: $ref: '#/components/schemas/InvalidRequestError' '401': description: The caller must be signed in. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: The caller cannot enter this key. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Unknown connection. content: application/json: schema: $ref: '#/components/schemas/ExternalMcpConnectionNotFoundError' '409': description: A marketplace plugin manages this connection's key. content: application/json: schema: $ref: >- #/components/schemas/ExternalMcpConnectionMarketplaceManagedError security: - denApiKey: [] - bearerAuth: [] components: schemas: ExternalMcpConnectionCredentialPromptResponse: type: object properties: connectionId: type: string scope: type: string enum: - shared - personal credentialPrompt: type: object properties: schemaVersion: type: string const: '1' kind: type: string const: credential_prompt target: oneOf: - type: object properties: type: type: string const: mcp_connection_key connectionId: type: string minLength: 1 maxLength: 160 required: - type - connectionId additionalProperties: false - type: object properties: type: type: string const: mcp_connection_member_key connectionId: type: string minLength: 1 maxLength: 160 required: - type - connectionId additionalProperties: false - type: object properties: type: type: string const: mcp_connection_shared_switch connectionId: type: string minLength: 1 maxLength: 160 expectedUpdatedAt: 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))$ audience: type: object properties: orgWide: type: boolean memberCount: type: integer minimum: 0 maximum: 100000 teamCount: type: integer minimum: 0 maximum: 100000 required: - orgWide - memberCount - teamCount additionalProperties: false required: - type - connectionId - expectedUpdatedAt - audience additionalProperties: false - type: object properties: type: type: string const: plugin_connection_key pluginId: type: string minLength: 1 maxLength: 160 configObjectId: type: string minLength: 1 maxLength: 160 serverName: type: string minLength: 1 maxLength: 255 connectionId: type: string minLength: 1 maxLength: 160 required: - type - pluginId - configObjectId - serverName - connectionId additionalProperties: false - type: object properties: type: type: string const: gateway_provider_key inferenceProviderId: type: string minLength: 1 maxLength: 160 credentialSetId: type: string minLength: 1 maxLength: 160 required: - type - inferenceProviderId - credentialSetId additionalProperties: false - type: object properties: type: type: string const: gateway_provider_credential inferenceProviderId: type: string minLength: 1 maxLength: 160 credentialSetId: type: string minLength: 1 maxLength: 160 credentialKind: type: string enum: - aws_keys - gcp_service_account - api_key_map envNames: minItems: 1 maxItems: 6 type: array items: type: string pattern: ^[A-Z][A-Z0-9_]{0,127}$ required: - type - inferenceProviderId - credentialSetId - credentialKind additionalProperties: false name: type: string minLength: 1 maxLength: 255 destination: anyOf: - type: string maxLength: 2048 - type: 'null' required: - schemaVersion - kind - target - name - destination additionalProperties: false nextStep: type: string required: - connectionId - scope - credentialPrompt - nextStep 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 ExternalMcpConnectionNotFoundError: type: object properties: error: type: string const: connection_not_found message: type: string required: - error - message ExternalMcpConnectionMarketplaceManagedError: type: object properties: error: type: string const: marketplace_managed message: type: string required: - error - message 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.