Conversations Overview

The Conversations API allows you to create and manage AI conversations. You can create general or persona conversations, continue existing conversations, and manage conversation metadata.

Available Endpoints

Creating Conversations

Create a General Conversation

Create a new general conversation with a specified AI system and model.

POST /conversations

Basic Request Format:

{
  "system": "string",
  "model": "string",
  "externalUserId": "string"
}

Create a Persona Conversation

Create a new conversation with a specific persona, which has predefined characteristics and behavior.

POST /conversations/persona

Basic Request Format:

{
  "personaId": "string",
  "externalUserId": "string"
}

Continuing Conversations

Continue Chat (Non-streaming)

Continue an existing conversation and get the complete response in a single API call.

POST /conversations/{conversationId}/continue

Continue Chat (HTTP/2 Streaming)

Continue an existing conversation and stream the response using HTTP/2 protocol.

POST /conversations/{conversationId}/continue-stream

Basic Request Format:

{
  "message": "string"
}

Continue Chat (SSE Streaming)

Continue an existing conversation and stream the response using Server-Sent Events (SSE) protocol.

POST /conversations/{conversationId}/continue-sse

Basic Request Format:

{
  "message": "string"
}

Retrieving Conversations

Get All Conversations

Retrieve all conversations for the organization.

GET /conversations

Get User Conversations

Retrieve all conversations for the current user.

GET /conversations/user/{externalUserId}

Get All Conversations with a Persona

Retrieve all conversations with a specific persona.

GET /conversations/persona/{personaId}

Get Specific Conversation

Retrieve a specific conversation by ID.

GET /conversations/{conversationId}

Managing Conversations

Set Conversation as Active

Mark a conversation as active.

PATCH /conversations/{conversationId}/set-active

Set Conversation's Metadata

Update the metadata for a conversation.

PATCH /conversations/{conversationId}/set-metadata

Set Conversation's Name

Update the name of a conversation.

PATCH /conversations/{conversationId}/set-conversation-name

Set Conversation's Status

Update the status of a conversation.

PATCH /conversations/{conversationId}/set-conversation-status

// Creating Conversations
POST / conversations;
POST / conversations / persona;
 
// Continuing Conversations
PATCH / conversations / { conversationId } / chat;
PATCH / conversations / { conversationId } / chat - http2;
PATCH / conversations / { conversationId } / chat - sse;
 
// Retrieving Conversations
GET / conversations;
GET / conversations / user / { externalUserId };
GET / conversations / persona / { personaId };
GET / conversations / { conversationId };
 
// Managing Conversations
PATCH / conversations / { conversationId } / set - active;
PATCH / conversations / { conversationId } / set - metadata;
PATCH / conversations / { conversationId } / set - conversation - name;
PATCH / conversations / { conversationId } / set - conversation - status;