Summarize file content

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

POST /ai/summarize

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.ai.summarize({ bucket: 'bucket', filename: 'filename' });

console.log(response.data);

200

{
  "data": {
    "summary": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

bucket · string · required

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

filename · string · required

The name of the file to be summarized.

system_prompt · string

A system prompt to guide the summary generation.

Response

200

application/json

Successful Response

data · SummaryResponse · object · required

Show child attributes