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

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

const canaryDeployResponse = await client.ai.assistants.canaryDeploys.create('assistant_id');

console.log(canaryDeployResponse.assistant_id);
{
  "assistant_id": "<string>",
  "rules": [
    {
      "serve": {
        "version_id": "<string>",
        "rollout": [
          {
            "version_id": "<string>",
            "weight": 50
          }
        ]
      },
      "match": [
        {
          "attribute": "<string>",
          "operator": "in",
          "values": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Create/update request body. Accepts:

  • rules — canonical ordered list of routing rules
​
rules
Rule · object[]

Response

Successful Response

Response shape.

Always carries rules (canonical).

​
assistant_id
string
required
​
rules
Rule · object[]
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required