Start AI Assistant

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.calls.actions.startAIAssistant('call_control_id');

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.calls.actions.start_ai_assistant(
    call_control_id="call_control_id",
)
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.Calls.Actions.StartAIAssistant(
		context.TODO(),
		"call_control_id",
		telnyx.CallActionStartAIAssistantParams{},
	)
	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;
import com.telnyx.sdk.models.calls.actions.ActionStartAiAssistantParams;
import com.telnyx.sdk.models.calls.actions.ActionStartAiAssistantResponse;

public final class Main {
    private Main() {}

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

        ActionStartAiAssistantResponse response = client.calls().actions().startAiAssistant("call_control_id");
    }
}

require "telnyx"

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

response = telnyx.calls.actions.start_ai_assistant("call_control_id")

puts(response)

<?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->calls->actions->startAIAssistant(
    'call_control_id',
    assistant: [
      'id' => 'id',
      'dynamicVariables' => [
        'customer_name' => 'John', 'account_id' => 'ACC-12345'
      ],
      'externalLlm' => [
        'authenticationMethod' => 'token',
        'baseURL' => 'base_url',
        'certificateRef' => 'certificate_ref',
        'forwardMetadata' => true,
        'llmAPIKeyRef' => 'llm_api_key_ref',
        'model' => 'model',
        'tokenRetrievalURL' => 'token_retrieval_url',
      ],
      'fallbackConfig' => [
        'externalLlm' => [
          'authenticationMethod' => 'token',
          'baseURL' => 'base_url',
          'certificateRef' => 'certificate_ref',
          'forwardMetadata' => true,
          'llmAPIKeyRef' => 'llm_api_key_ref',
          'model' => 'model',
          'tokenRetrievalURL' => 'token_retrieval_url',
        ],
        'llmAPIKeyRef' => 'llm_api_key_ref',
        'model' => 'model',
      ],
      'greeting' => 'greeting',
      'instructions' => 'You are a friendly voice assistant.',
      'llmAPIKeyRef' => 'my_llm_api_key',
      'mcpServers' => [['foo' => 'bar']],
      'model' => 'gpt-4o',
      'name' => 'name',
      'observabilitySettings' => ['foo' => 'bar'],
      'openaiAPIKeyRef' => 'my_openai_api_key',
      'tools' => [
        [
          'bookAppointment' => [
            'apiKeyRef' => 'my_calcom_api_key',
            'eventTypeID' => 0,
            'attendeeName' => 'attendee_name',
            'attendeeTimezone' => 'attendee_timezone',
          ],
          'type' => 'book_appointment',
        ],
      ],
    ],
    clientState: 'aGF2ZSBhIG5pY2UgZGF5ID1d',
    commandID: '891510ac-f3e4-11e8-af5b-de00688a4901',
    greeting: 'Hello, can you tell me your age and where you live?',
    interruptionSettings: ['enable' => true],
    messageHistory: [
      [
        'content' => 'Hello, I would like some help.',
        'role' => 'user',
        'metadata' => ['foo' => 'bar'],
      ],
    ],
    participants: [
      [
        'id' => 'v3:abc123def456',
        'role' => 'user',
        'name' => 'John Doe',
        'onHangup' => 'continue_conversation',
      ],
    ],
    sendMessageHistoryUpdates: true,
    transcription: [
      'language' => 'auto', 'model' => 'distil-whisper/distil-large-v2'
    ],
    voice: 'Telnyx.KokoroTTS.af',
    voiceSettings: [
      'type' => 'elevenlabs', 'apiKeyRef' => 'my_elevenlabs_api_key'
    ],
  );

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

telnyx calls:actions start-ai-assistant \
  --api-key 'My API Key' \
  --call-control-id call_control_id

curl --request POST \
  --url https://api.telnyx.com/v2/calls/{call_control_id}/actions/ai_assistant_start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "greeting": "Hello, can you tell me your age and where you live?",
  "interruption_settings": {
    "enable": true
  },
  "transcription": {
    "model": "distil-whisper/distil-large-v2",
    "language": "<string>"
  },
  "message_history": [],
  "send_message_history_updates": false,
  "participants": [],
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901"
}
'