Skip to main content

​
What it is

This API was designed for conversational experiences exposed to end users. The main use case is the chat widget provided by Quintus, along with other public-facing scenarios enabled by the team.

​
When to use it

  • the Quintus chat widget;
  • an agent on a landing page;
  • support inside a mobile app;
  • an assistant in a customer portal.
For enablement, configuration, and best practices in public environments, contact Quintus support.

​
How it works

  1. Your backend creates the conversation with X-API-Key.
  2. The API returns conversation_id and session_token.
  3. The client uses Authorization: Bearer <session_token> for conversation calls.
  4. When needed, the backend refreshes the token with the API key.

​
Main resources

  • Conversations: creation, retrieval, refresh, and termination.
  • Messages: synchronous send, streaming, and history.
  • Files: attachments per conversation.
  • Feedback: experience rating at the end of the flow.