Telnyx AI Assistants Javascript

Telnyx AI Assistants - JavaScript

Installation

npm install telnyx@6.74.2

Setup

import Telnyx from 'telnyx';

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

All examples below assume client is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

try {
  const assistant = await client.ai.assistants.create({
    instructions: 'You are a helpful assistant.',
    name: 'my-resource',
      model: 'openai/gpt-4o',
  });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

• Phone numbers must be in E.164 format (e.g., +13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses.
• Pagination: List methods return an auto-paginating iterator. Use for await (const item of result) { ... } to iterate through all pages automatically.

Reference Use Rules

Do not invent Telnyx parameters, enums, response fields, or webhook fields.

• If the parameter, enum, or response field you need is not shown inline in this skill, read references/api-details.md before writing code.
• Before using any operation in ## Additional Operations, read the optional-parameters section and the response-schemas section.

Core Tasks

Create an assistant

Assistant creation is the entrypoint for any AI assistant integration. Agents need the exact creation method and the top-level fields returned by the SDK.

client.ai.assistants.create() — POST /ai/assistants

const assistant = await client.ai.assistants.create({
  instructions: 'You are a helpful assistant.',
  name: 'my-resource',
    model: 'openai/gpt-4o',
});

console.log(assistant.id);

Primary response fields:

• assistant.id
• assistant.name
• assistant.model
• assistant.instructions
• assistant.createdAt
• assistant.conversationFlow

Chat with an assistant

Chat is the primary runtime path. Agents need the exact assistant method and the response content field.

client.ai.assistants.chat() — POST /ai/assistants/{assistant_id}/chat

const response = await client.ai.assistants.chat('assistant_id', {
  content: 'Tell me a joke about cats',
  conversation_id: '42b20469-1215-4a9a-8964-c36f66b406f4',
});

console.log(response.content);

Primary response fields:

• response.content

Create an assistant test

Test creation is the main validation path for production assistant behavior before deployment.

client.ai.assistants.tests.create() — POST /ai/assistants/tests

const assistantTest = await client.ai.assistants.tests.create({
  destination: '+15551234567',
  instructions:
    'Act as a frustrated customer who received a damaged product. Ask for a refund and escalate if not satisfied with the initial response.',
  name: 'Customer Support Bot Test',
  rubric: [
    { criteria: 'Assistant responds within 30 seconds', name: 'Response Time' },
    { criteria: 'Provides correct product information', name: 'Accuracy' },
  ],
});

console.log(assistantTest.test_id);

Primary response fields:

• assistantTest.testId
• assistantTest.name
• assistantTest.destination
• assistantTest.createdAt
• assistantTest.instructions
• assistantTest.description

Important Supporting Operations

Use these when the core tasks above are close to your flow, but you need a common variation or follow-up step.

Get an assistant

Fetch the current state before updating, deleting, or making control-flow decisions.

client.ai.assistants.retrieve() — GET /ai/assistants/{assistant_id}

const assistant = await client.ai.assistants.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(assistant.id);

Primary response fields:

• assistant.id
• assistant.name
• assistant.createdAt
• assistant.conversationFlow
• assistant.description
• assistant.dynamicVariables

Update an assistant

Create or provision an additional resource when the core tasks do not cover this flow.

client.ai.assistants.update() — POST /ai/assistants/{assistant_id}

const assistant = await client.ai.assistants.update('550e8400-e29b-41d4-a716-446655440000');

console.log(assistant.id);

Primary response fields:

• assistant.id
• assistant.name
• assistant.createdAt
• assistant.conversationFlow
• assistant.description
• assistant.dynamicVariables

List assistants

Inspect available resources or choose an existing resource before mutating it.

client.ai.assistants.list() — GET /ai/assistants

const assistantsList = await client.ai.assistants.list();

console.log(assistantsList.data);

Response wrapper:

• items: assistantsList.data

Primary item fields:

• id
• name
• createdAt
• conversationFlow
• description
• dynamicVariables

Import assistants from external provider

Import existing assistants from an external provider instead of creating from scratch.

client.ai.assistants.imports() — POST /ai/assistants/import

const assistantsList = await client.ai.assistants.imports({
  api_key_ref: 'my-openai-key',
  provider: 'elevenlabs',
});

console.log(assistantsList.data);

Response wrapper:

• items: assistantsList.data

Primary item fields:

• id
• name
• createdAt
• conversationFlow
• description
• dynamicVariables

Get All Tags

Inspect available resources or choose an existing resource before mutating it.

client.ai.assistants.tags.list() — GET /ai/assistants/tags

const tags = await client.ai.assistants.tags.list();

console.log(tags.tags);

Primary response fields:

• tags.tags

List assistant tests with pagination

Inspect available resources or choose an existing resource before mutating it.

client.ai.assistants.tests.list() — GET /ai/assistants/tests

// Automatically fetches more pages as needed.
for await (const assistantTest of client.ai.assistants.tests.list()) {
  console.log(assistantTest.test_id);
}

Response wrapper:

• items: assistantTest.data
• pagination: assistantTest.meta

Primary item fields:

• name
• createdAt
• description
• destination
• instructions
• maxDurationSeconds

Get all test suite names

Inspect available resources or choose an existing resource before mutating it.

client.ai.assistants.tests.testSuites.list() — GET /ai/assistants/tests/test-suites

const testSuites = await client.ai.assistants.tests.testSuites.list();

console.log(testSuites.data);

Response wrapper:

• items: testSuites.data

Primary item fields:

• data

Get test suite run history

Fetch the current state before updating, deleting, or making control-flow decisions.

client.ai.assistants.tests.testSuites.runs.list() — GET /ai/assistants/tests/test-suites/{suite_name}/runs

// Automatically fetches more pages as needed.
for await (const testRunResponse of client.ai.assistants.tests.testSuites.runs.list('suite_name')) {
  console.log(testRunResponse.run_id);
}

Response wrapper:

• items: testRunResponse.data
• pagination: testRunResponse.meta

Primary item fields:

• status
• createdAt
• updatedAt
• completedAt
• conversationId
• conversationInsightsId

Additional Operations

Use the core tasks above first. The operations below are indexed here with exact SDK methods and required params; use references/api-details.md for full optional params, response schemas, and lower-frequency webhook payloads. Before using any operation below, read the optional-parameters section and the response-schemas section so you do not guess missing fields.

For exhaustive optional parameters, full response schemas, and complete webhook payloads, see references/api-details.md.