Get Insight Template

GET 
/ai/conversations/insights/:insight_id

Get insight by ID

Path Parameters

insight_id uuidrequired

The ID of the insight

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

required

id uuidrequired

instructions Instructions (string)required

created_at date-timerequired

insight_type TemplateType (string)

Possible values: [custom, default]

Default value: custom

name Name (string)

webhook Webhook (string)

json_schema

object

If specified, the output will follow the JSON schema.

anyOf

• MOD1
• MOD2

string

object

If specified, the output will follow the JSON schema.

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "instructions": "string",
    "created_at": "2024-07-29T15:51:28.071Z",
    "insight_type": "custom",
    "name": "string",
    "webhook": "string",
    "json_schema": "string"
  }
}

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/insights/:insight_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 422

---

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "instructions": "string",
    "created_at": "2024-07-29T15:51:28.071Z",
    "insight_type": "custom",
    "name": "string",
    "webhook": "string",
    "json_schema": "string"
  }
}

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