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

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

const canaryDeployResponse = await client.ai.assistants.canaryDeploys.create('assistant_id', {
  versions: [{ percentage: 1, version_id: 'version_id' }],
});

console.log(canaryDeployResponse.assistant_id);
{
  "assistant_id": "<string>",
  "versions": [
    {
      "version_id": "<string>",
      "percentage": 123
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

Request model for creating or updating canary deploys.

​
versions
VersionConfig · object[]
required

List of version configurations

Response

Successful Response

Response model for canary deploy operations.

​
assistant_id
string
required
​
versions
VersionConfig · object[]
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required