Skip to main content
POST
/
v1
/
summary
Generates a summary of a conversation or ticket
curl --request POST \
  --url https://api1.irisagent.com/v1/summary \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationId": "<string>",
  "subject": "<string>",
  "description": "<string>",
  "comments": [
    {
      "comment": "<string>",
      "commenter": "Customer"
    }
  ],
  "format": "markdown"
}
'
{
  "format": "markdown",
  "summary": "<string>"
}

Authorizations

​
Authorization
string
header
required

The Authorization header is required to authenticate API requests. It should contain a bearer token obtained through the IrisAgent portal.

Headers

​
X-Language-Iso-Code
string<iso-639-1>

This optional header allows you to specify the desired language. If not provided, automatic language detection will be used.

Body

application/json
​
conversationId
string
required

Unique ticket or chat id

​
subject
string

Initial query by the customer

​
description
string

Details on the initial query by the customer

​
comments
object[]

Array of messages between customer and agent

​
format
enum<string>
default:markdown
Available options:
markdown,
html

Response

The generated conversation summary

​
format
enum<string>
default:markdown
required
Available options:
markdown,
html
​
summary
string
required

Markdown-formatted summary of the conversation