Skip to main content
POST
/
ai
/
conversations
/
insights
JavaScript
import Telnyx from 'telnyx';

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

const insightTemplateDetail = await client.ai.conversations.insights.create({
  instructions: 'instructions',
  name: 'name',
});

console.log(insightTemplateDetail.data);
import os
from telnyx import Telnyx

client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
insight_template_detail = client.ai.conversations.insights.create(
instructions="instructions",
name="name",
)
print(insight_template_detail.data)
package main

import (
"context"
"fmt"

"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)

func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
insightTemplateDetail, err := client.AI.Conversations.Insights.New(context.TODO(), telnyx.AIConversationInsightNewParams{
Instructions: "instructions",
Name: "name",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", insightTemplateDetail.Data)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.ai.conversations.insights.InsightCreateParams;
import com.telnyx.sdk.models.ai.conversations.insights.InsightTemplateDetail;

public final class Main {
private Main() {}

public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();

InsightCreateParams params = InsightCreateParams.builder()
.instructions("instructions")
.name("name")
.build();
InsightTemplateDetail insightTemplateDetail = client.ai().conversations().insights().create(params);
}
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

insight_template_detail = telnyx.ai.conversations.insights.create(instructions: "instructions", name: "name")

puts(insight_template_detail)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
$insightTemplateDetail = $client->ai->conversations->insights->create(
instructions: 'instructions',
name: 'name',
jsonSchema: 'string',
webhook: 'webhook',
);

var_dump($insightTemplateDetail);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx ai:conversations:insights create \
--api-key 'My API Key' \
--instructions instructions \
--name name
curl --request POST \
--url https://api.telnyx.com/v2/ai/conversations/insights \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"instructions": "<string>",
"name": "<string>",
"webhook": "",
"json_schema": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "instructions": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "insight_type": "custom",
    "name": "",
    "webhook": "",
    "json_schema": "<string>"
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

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

Body

application/json
instructions
string
required
name
string
required
webhook
string
default:""
json_schema

If specified, the output will follow the JSON schema.

Response

Successful Response

data
InsightTemplateResp · object
required