Test Assistant Tool

POST

assistants

{assistant_id}

tools

{tool_id}

test

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.assistants.tools.test('tool_id', { assistant_id: 'assistant_id' });

console.log(response.data);

{
  "data": {
    "success": true,
    "status_code": 123,
    "content_type": "<string>",
    "response": "<string>",
    "request": {}
  }
}

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

Unique identifier of the assistant.

tool_id

string

required

Unique identifier of the tool.

Body

application/json

Request model for testing a webhook tool

arguments

Arguments · object

Key-value arguments to use for the webhook test

dynamic_variables

Dynamic Variables · object

Key-value dynamic variables to use for the webhook test

Response

Successful Response

Response model for webhook tool test results

data

TestWebhookToolResponse · object

required

Response model for webhook tool test results

Show child attributes

Get assistant texml

Get All Tags

⌘I

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.assistants.tools.test('tool_id', { assistant_id: 'assistant_id' });

console.log(response.data);

{
  "data": {
    "success": true,
    "status_code": 123,
    "content_type": "<string>",
    "response": "<string>",
    "request": {}
  }
}