Telnyx

POST

summarize

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);

{
  "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

Successful Response

data

SummaryResponse · object

required

Show child attributes

List embedding models

⌘I

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);

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

Documentation Index

Authorizations

Body

Response