/telnyx-ai-assistants-javascript

name: telnyx-ai-assistants-javascript
description: >-
  AI voice assistants with custom instructions, knowledge bases, and tool
  integrations.
metadata:
  author: telnyx
  product: ai-assistants
  language: javascript
  generated_by: telnyx-openapi-pipeline
  contract: v2

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

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](references/api-details.md) before writing code.
• Before using any operation in `## Additional Operations`, read [the optional-parameters section](references/api-details.md#optional-parameters) and [the response-schemas section](references/api-details.md#response-schemas).

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`

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | | | `instructions` | string | Yes | System instructions for the assistant. | | `tags` | array[string] | No | Tags associated with the assistant. | | `model` | string | No | ID of the model to use when `external_llm` is not set. | | `tools` | array[object] | No | Deprecated for new integrations. | | ... | | | +23 optional params in [references/api-details.md](references/api-details.md) |

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`

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content` | string | Yes | The message content sent by the client to the assistant | | `conversation_id` | string (UUID) | Yes | A unique identifier for the conversation thread, used to mai... | | `assistant_id` | string (UUID) | Yes | Unique identifier of the assistant. | | `name` | string | No | The optional display name of the user sending the message |

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`

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | A descriptive name for the assistant test. | | `destination` | string | Yes | The target destination for the test conversation. | | `instructions` | string | Yes | Detailed instructions that define the test scenario and what... | | `rubric` | array[object] | Yes | Evaluation criteria used to assess the assistant's performan... | | `description` | string | No | Optional detailed description of what this test evaluates an... | | `telnyx_conversation_channel` | object | No | The communication channel through which the test will be con... | | `max_duration_seconds` | integer | No | Maximum duration in seconds that the test conversation shoul... | | ... | | | +1 optional params in [references/api-details.md](references/api-details.md) |

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.