API Reference

Integrate Assistly into custom pipelines using our REST HTTP API. All requests require a Bearer token.

AUTHAuthorization: Bearer YOUR_API_KEY
POST/v1/chat/message

Send a message to an active AI support agent session and receive the response payload.

Request Body

{
  "sessionId": "session_9827",
  "message": "What is my delivery status?"
}

Response Payload

{
  "success": true,
  "reply": "Your package is currently in transit...",
  "sentiment": "neutral",
  "handoffTriggered": false
}
GET/v1/sessions/:id

Retrieve the full conversation history and metadata for a given session ID.

Request Body

// No request body — pass sessionId as URL param

Response Payload

{
  "sessionId": "session_9827",
  "messages": [...],
  "sentiment": "neutral",
  "createdAt": 1718712300
}