Prerequisites
What you need before integrating your product with Tuix AI Agents.
Before talking to your agent from code you need:
- A Tuix account to access the dashboard.
- An application and its Application ID. See Create an application.
- A way to authenticate: either the end user's own credential, or an API key from the Tuix dashboard. See API keys.
- The API base URL (see below).
Base URL
All requests to your agent's chat and session endpoints go to:
Authentication
Every call to your application's session and chat endpoints is authenticated with one of the following:
| Header | Use it when... |
|---|---|
Authorization | You already sign your users in, and want the agent to act with that user's own credential. |
X-Api-Key | There is no signed-in user to speak for (a public chat, a backend automation), so the agent authenticates with a key you created instead. |
Both are described in detail in Application endpoints,
together with the x-session-secret header every chat request also needs.
An API key gives full access to the application it belongs to. Keep it on the server; a public chat that needs one requires a backend to sit between the browser and Tuix AI Agents. See API keys.