Skip to main content
Create an API credential for the intended workspace in Developer, then send it in the x-chatobserver-key header or as a bearer token. Keep credentials on your server or in your integration’s secret store. The public API is served from https://app.chatobserver.com/api. Version 2 routes begin with /v2.

​
Validate a visibility API credential

Store your credential in the CHATOBSERVER_API_KEY environment variable, then run:
The response identifies the credential’s scopes, capabilities, and default project. Use /v2/projects to retrieve the associated project details. Bearer authentication is also supported:
Send one authentication method per request. If both headers are present, x-chatobserver-key takes precedence.

​
Choose the required scopes

Visibility read operations require read. Creating or modifying prompts, brands, tags, or personas also requires write. Use a read-only credential for exports that do not need to change the workspace. The Data API requires a service-account credential and operation-specific metrics:* scopes. A visibility key with write does not automatically grant Data API access.

​
Keep workspace boundaries explicit

Credentials are workspace-scoped. An optional x-project-id header selects the matching project; it does not grant access to another workspace. Retrieve the project identifier from the API rather than constructing it from an organisation name. Never place a secret key in a public website, browser bundle, screenshot, or shared report. Revoke a credential when its integration no longer needs access.