Skip to main content
Choose the credential for the operation you are performing. A personal API key, dashboard session, provider secret, and conversation token have different purposes and should not be exchanged as substitutes.

​
Credential boundaries

​
Server-side API access

Create a scoped key in workspace API keys and send it in x-api-key. Follow the authentication reference for header examples and error handling. Do not send both x-api-key and Authorization in one request. Keep the key out of client-side JavaScript, URLs, prompts, screenshots, and logs. Give separate services their own keys so you can revoke one without disrupting unrelated integrations.

​
Workspace and resource access

A valid credential does not guarantee access to every workspace resource or operation. Check the workspace, key permissions, and resource access. Tool management and billing administration currently have different credential requirements from ordinary public API reads. Use environment variables for supported strings and credential references. A reference identifies a workspace resource; it does not grant a new user or agent permission to use it. For provider credentials, follow auth connections or workspace secrets. A native integration manages its provider connection through a separate workflow.

​
Conversation access

Public conversation token and signed-URL initiation are currently gated in the documented implementation. Agent authentication settings can be represented in configuration, but their presence does not establish a working protected session.
The dashboard’s preview Security controls are not a verified persisted setup workflow. Do not rely on a preview toggle as proof of authentication enforcement. When a supported runtime path is released, assess token scope, expiry, workspace ownership, and unauthorized access against that release.

​
Frequently asked questions

No. Keep the key server-side. A browser integration needs its own supported session-access design and must not expose a workspace credential.
The key can authenticate while lacking permission, resource access, an allowed source IP, or support for that credential type on the operation.
No. A local preview control or stored setting must be distinguished from released runtime enforcement.