Conversations
Get a conversation
Retrieve a single conversation by ID for the authenticated visitor in the current project, including its messages and human agent info if assigned.
AuthorizationBearer <token>
In: header
Path Parameters
conversationIdstring
The unique identifier of the conversation
Format
uuid
Response Body
curl -X GET "https://api.siteassist.io/v2/conversations/123e4567-e89b-12d3-a456-426614174000"
{
"object": "conversation",
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"status": "open",
"closedAt": null,
"closeReason": null,
"lastInterationAt": "2024-01-15T10:35:00.000Z",
"isHumanHandled": false,
"humanAgent": null,
"messages": []
}
{
"error": {
"message": "Invalid request body. Content is required.",
"code": "INVALID_REQUEST_BODY",
"details": {
"field": "content"
}
}
}
{
"error": {
"message": "Authentication required",
"code": "UNAUTHORIZED"
}
}
{
"error": {
"message": "A higher pricing plan is required to access this feature",
"code": "PAYMENT_REQUIRED",
"details": {
"currentPlan": "free",
"requiredPlan": "pro",
"feature": "advanced_ai_models"
}
}
}
{
"error": {
"message": "Access denied to this conversation",
"code": "FORBIDDEN"
}
}
{
"error": {
"message": "Conversation not found!",
"code": "CONVERSATION_NOT_FOUND",
"details": {
"conversationId": "123e4567-e89b-12d3-a456-426614174000"
}
}
}
{
"error": {
"message": "Resource already exists",
"code": "CONFLICT",
"details": {
"resource": "conversation",
"conflictingField": "id"
}
}
}
{
"error": {
"message": "Validation failed",
"code": "VALIDATION_ERROR",
"details": {
"field": "content",
"reason": "Content exceeds maximum length of 10000 characters"
}
}
}
{
"error": {
"message": "Rate limit exceeded. Please try again later.",
"code": "RATE_LIMIT_EXCEEDED",
"details": {
"retryAfter": 60
}
}
}
{
"error": {
"message": "An internal server error occurred",
"code": "INTERNAL_SERVER_ERROR"
}
}
{
"error": {
"message": "Service temporarily unavailable",
"code": "BAD_GATEWAY",
"details": {
"service": "ai_model_service"
}
}
}
{
"error": {
"message": "Service temporarily unavailable",
"code": "SERVICE_UNAVAILABLE",
"details": {
"retryAfter": 30
}
}
}
Close a conversation POST
Close an open conversation for the authenticated visitor in the current project. Optionally include a close reason.
List conversations GET
Retrieve a paginated list of conversations for the authenticated visitor within the current project. Supports filtering, ordering, and pagination.