Summarize file content

POST 
/ai/summarize

Generate a summary of a file's contents.

Supports the following text formats:

• PDF, HTML, txt, json, csv

Supports the following media formats (billed for both the transcription and summary):

• flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm
• Up to 100 MB

application/json

Body

required

bucket stringrequired

The name of the bucket that contains the file to be summarized.

filename stringrequired

The name of the file to be summarized.

system_prompt string

A system prompt to guide the summary generation.

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

required

summary Summary (string)required

{
  "data": {
    "summary": "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/summarize' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "bucket": "string",
  "filename": "string",
  "system_prompt": "string"
}'

Response samples

• 200
• 422

---

{
  "data": {
    "summary": "string"
  }
}

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