Create an API key

Zelinqa API keys are backend-only secrets. They automatically identify your organization and domain, so a trusted tenant_id is never supplied by a browser client.

Choose permissions

Scope	Use
`runtime`	Create and advance sessions, read their state, and submit feedback.
`configuration:read`	Read the published configuration, questions, and compilation status.
`configuration:write`	Read and modify the draft.
`configuration:publish`	Publish and read the configuration audit log. Combine with `configuration:read` to poll compilation.

For a conversational integration, create a key containing only runtime. Use separate keys for production, testing, and administration.

Open API Keys

In Zelinqa Studio, select the relevant domain and open API Keys.

Create the key

Select only the required permissions. The complete secret is displayed once.

Store the secret

Copy it to your backend secret manager, never to a browser or Git repository.

export ZELINQA_API_KEY="nbq_live_xxx"

A lost key cannot be displayed again. Revoke it and create a new one. Revocation takes effect immediately.

Configure

Publish and operate

Create an API key

Choose permissions

​Choose permissions

Choose permissions