Overview
An overview of the Assistant API and the embeddable widget integration.
What is this?
The Assistant platform provides an API for building conversation-driven assistants and an embeddable widget that can be placed on websites. The typical architecture separates secret-bearing server code from browser code by issuing short-lived widget tokens.
Core Concepts
- Assistant: a configured conversational agent.
- Session: a temporary context for a visitor interacting with an assistant.
- Widget token: short-lived JWT for authenticating widgets in browsers.
- Auth: JWTs or API key pair headers (X-API-Key + X-API-Secret).
How it works (high level)
- Server holds client secret and exchanges it for a short-lived widget token via /api/auth/widget-token.
- Browser receives token and initializes the widget; widget uses the token to call API endpoints.
- Server-side endpoints accept JWTs or API key header pairs and apply organization-level rate limits.
Next steps
Follow the Quickstart to embed the widget, then consult the API Reference for details.