Get insights for a conversation

GET 
/ai/conversations/:conversation_id/conversations-insights

Retrieve insights for a specific conversation

Path Parameters

conversation_id stringrequired

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

required

Array [

id stringrequired

Unique identifier for the conversation insight.

status stringrequired

Possible values: [pending, in_progress, completed, failed]

Current status of the insight generation for the conversation.

created_at date-timerequired

Timestamp of when the object was created.

conversation_insights

object[]

required

List of insights extracted from the conversation.

Array [

result stringrequired

Insight result from the conversation. If the insight has a JSON schema, this will be stringified JSON object.

insight_id stringrequired

Unique identifier for the insight configuration.

]

List of insights extracted from the conversation.

]

meta

object

required

total_pages integerrequired

total_results integerrequired

page_number integerrequired

page_size integerrequired

{
  "data": [
    {
      "id": "string",
      "status": "pending",
      "created_at": "2024-07-29T15:51:28.071Z",
      "conversation_insights": [
        {
          "result": "string",
          "insight_id": "string"
        }
      ]
    }
  ],
  "meta": {
    "total_pages": 0,
    "total_results": 0,
    "page_number": 0,
    "page_size": 0
  }
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/ai/conversations/:conversation_id/conversations-insights' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 422

---

{
  "data": [
    {
      "id": "string",
      "status": "pending",
      "created_at": "2024-07-29T15:51:28.071Z",
      "conversation_insights": [
        {
          "result": "string",
          "insight_id": "string"
        }
      ]
    }
  ],
  "meta": {
    "total_pages": 0,
    "total_results": 0,
    "page_number": 0,
    "page_size": 0
  }
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}