Serverless AI Conversation Summary
AI powered conversation summarizer that creates a concise overview of a conversation history. The service analyzes the conversation history and generates a summary highlighting the key points, decisions, and action items discussed.
Endpoint
Generate a concise summary of a conversation history.
POSThttps://api.xtartapp.com/bot/summary
*Authentication
You must use a Bearer token provided by the dashboard to use for authentication. Add the token to the Authorization header.
Request body
Name | Type | Required | Max | Description |
---|---|---|---|---|
history | array | Yes | - | Array of conversation messages with role (user/bot) and content |
language | string | No | - | Language code for the summary (e.g., 'en', 'fr', 'es', 'auto') |
Response
Name | Type | Description |
---|---|---|
data | object | The summary data |
data.summary | string | The generated conversation summary |
data.confidence | number | Confidence score for the summary (0.0 to 1.0) |
data.language | string | The language of the generated summary |
metadata | object | Metadata about the summary generation process |
metadata.cost | number | The cost of the summary generation request |
Errors
{
"error": "string",
"code": "string"
}
HTTP Status | Error Code | Message |
---|---|---|
400 | INVALID_PAYLOAD | Occurs when the payload is invalid. |
400 | INVALID_REQUEST | Ex.: The request is invalid. |
400 | BOT_SUMMARY_ERROR | Ex: could not generate summary for the conversation | parsing error |
400 | HARM_CONTENT | Ex.: The content is harmful and cannot be processed. |
400 | INSUFFICIENT_BALANCE | The user has insufficient balance |
401 | UNAUTHORIZED | Ex.: The token is invalid. |
429 | TOO_MANY_REQUESTS | Ex.: The request limit has been reached. |