List test personalities

GET

tests

test_framework

personalities

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.tests.testFramework.v1.retrievePersonalities();

console.log(response.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
)
response = client.ai.tests.test_framework.v1.retrieve_personalities()
print(response.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"),
	)
	response, err := client.AI.Tests.TestFramework.V1.GetPersonalities(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

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

        var response = client.ai().tests().testFramework().v1().retrievePersonalities();
    }
}

<?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 {
  $response = $client->ai->tests->testFramework->v1->retrievePersonalities();

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

[
  {
    "id": 4643,
    "name": "Interruptive (High)",
    "prompt": "Speak very impatiently. Comment on trivial things and rarely let others finish speaking.",
    "language": "uk",
    "accent": "Ukrainian",
    "interruption_level": "high",
    "end_call_enabled": true
  }
]

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The AI Tests service rejected the request."
    }
  ]
}

{
  "errors": [
    {
      "code": "10003",
      "title": "Unauthorized",
      "detail": "The API key is missing or invalid."
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Not Found",
      "detail": "The requested resource or URL could not be found."
    }
  ]
}

{
  "errors": [
    {
      "code": "10018",
      "title": "Unprocessable Entity",
      "detail": "Validation failed for the request payload."
    }
  ]
}

{
  "errors": [
    {
      "code": "10029",
      "title": "Too Many Requests",
      "detail": "Too many requests; retry later."
    }
  ]
}

{
  "errors": [
    {
      "code": "10063",
      "title": "Service Unavailable",
      "detail": "The test framework service is temporarily unavailable."
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Response

List of test personalities.

integer

required

name

string

required

Display name of the personality.

prompt

string

required

Instructions the simulated caller follows.

language

string

required

ISO language code the simulated caller speaks.

end_call_enabled

boolean

required

forked_from

integer | null

ID of the personality this one was forked from.

organization

integer | null

project

integer | null

accent

string

background_noise

string | null

interruption_level

string | null

How aggressively the personality interrupts the assistant.

speed

generation_config

object | null

network_simulation

object | null

message_plan

object | null

Idle-timeout plan for messages during a call.

start_speaking_plan

stop_speaking_plan

object | null

background_sound_volume

number | null

voice_volume

number | null

effective_voice_volume

number | null

Example:

[
  {
    "id": 4643,
    "name": "Interruptive (High)",
    "prompt": "Speak very impatiently. Comment on trivial things and rarely let others finish speaking.",
    "language": "uk",
    "accent": "Ukrainian",
    "interruption_level": "high",
    "end_call_enabled": true
  }
]

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.tests.testFramework.v1.retrievePersonalities();

console.log(response.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
)
response = client.ai.tests.test_framework.v1.retrieve_personalities()
print(response.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"),
	)
	response, err := client.AI.Tests.TestFramework.V1.GetPersonalities(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

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

        var response = client.ai().tests().testFramework().v1().retrievePersonalities();
    }
}

<?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 {
  $response = $client->ai->tests->testFramework->v1->retrievePersonalities();

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

[
  {
    "id": 4643,
    "name": "Interruptive (High)",
    "prompt": "Speak very impatiently. Comment on trivial things and rarely let others finish speaking.",
    "language": "uk",
    "accent": "Ukrainian",
    "interruption_level": "high",
    "end_call_enabled": true
  }
]

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The AI Tests service rejected the request."
    }
  ]
}

{
  "errors": [
    {
      "code": "10003",
      "title": "Unauthorized",
      "detail": "The API key is missing or invalid."
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Not Found",
      "detail": "The requested resource or URL could not be found."
    }
  ]
}

{
  "errors": [
    {
      "code": "10018",
      "title": "Unprocessable Entity",
      "detail": "Validation failed for the request payload."
    }
  ]
}

{
  "errors": [
    {
      "code": "10029",
      "title": "Too Many Requests",
      "detail": "Too many requests; retry later."
    }
  ]
}

{
  "errors": [
    {
      "code": "10063",
      "title": "Service Unavailable",
      "detail": "The test framework service is temporarily unavailable."
    }
  ]
}

Guides

Missions

AI Insights

Assistants API

Missions API

AI Tests API

Conversations API

For AI Agents

List test personalities

Authorizations

Response