Skip to main content
POST
/
ai
/
assistants
/
{assistant_id}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const assistant = await client.ai.assistants.update('assistant_id');

console.log(assistant);
"<any>"

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
assistant_id
string
required

Body

application/json
​
name
string
​
model
string

ID of the model to use. You can use the Get models API to see all of your available models,

​
instructions
string

System instructions for the assistant. These may be templated with dynamic variables

​
tools
(WebhookTool · object | RetrievalTool · object | HandoffTool · object | HangupTool · object | TransferTool · object | SIPReferTool · object | DTMFTool · object)[]

The tools that the assistant can use. These may be templated with dynamic variables

  • WebhookTool
  • RetrievalTool
  • HandoffTool
  • HangupTool
  • TransferTool
  • SIPReferTool
  • DTMFTool
​
description
string
​
greeting
string

Text that the assistant will use to start the conversation. This may be templated with dynamic variables

​
llm_api_key_ref
string

This is only needed when using third-party inference providers. The identifier for an integration secret /v2/integration_secrets that refers to your LLM provider's API key. Warning: Free plans are unlikely to work with this integration.

​
voice_settings
object
​
transcription
object
​
telephony_settings
object
​
messaging_settings
object
​
enabled_features
enum<string>[]
​
insight_settings
object
​
privacy_settings
object
​
dynamic_variables_webhook_url
string

If the dynamic_variables_webhook_url is set for the assistant, we will send a request at the start of the conversation. See our guide for more information.

​
dynamic_variables
object

Map of dynamic variables and their default values

​
promote_to_main
boolean
default:true

Indicates whether the assistant should be promoted to the main version. Defaults to true.

Response

Successful Response

The response is of type any.