API overview
The routes your server and your page or app call to run a conversation.
The API lives at https://api.nuancelabs.ai. Every request authenticates with a bearer token in the Authorization header.
| Called from | Credential | Routes |
|---|---|---|
| Your server | API key, nk_ | Create a session token, get a transcript, list active conversations, end a conversation, get your usage |
| Your page or app | Session token, st_ | Create, get, follow and abandon a conversation. |
Connect shows the calls your page or app makes, and API keys and session tokens how the two credentials fit together. Once the conversation's room is joined, everything else is Nuance Live events on its nuance_live topic.
The OpenAPI spec (https://docs.nuancelabs.ai/openapi.json) describes every route here, for generating a client or giving to a coding agent.
Troubleshooting
What to check when the AI persona is silent, can't hear the person, hears itself, or a conversation won't start.
Create a session token POST
Mints a session token that your page or app can start one Nuance Live conversation with. Call it from your server with an API key, never from a browser. What you send here (the interface and its setup, the personality and your id for the person) is fixed for the conversation the token creates.