Update Canary Deploy

Endpoint to update a canary deploy configuration for an assistant.

Updates the existing canary deploy configuration with new version IDs and percentages. All old versions and percentages are replaces by new ones from this request.

PUT /ai/assistants/{assistant_id}/canary-deploys

JavaScript

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.update('assistant_id', {
  versions: [{ percentage: 1, version_id: 'version_id' }],
});

console.log(canaryDeployResponse.assistant_id);

200

{
  "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

Show child attributes

Response

200

application/json

Successful Response

Response model for canary deploy operations.

assistant_id · string · required

versions · VersionConfig · object[] · required

Show child attributes

created_at · string<date-time> · required

updated_at · string<date-time> · required