Update Canary Deploy

PUT 
/ai/assistants/:assistant_id/canary-deploys

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.

Path Parameters

assistant_id Assistant Idrequired

application/json

Body

required

versions

object[]

required

List of version configurations

Array [

version_id Version Id (string)required

Version ID string that references assistant_versions.version_id

percentage Percentage (number)required

Possible values: < 100

Percentage of traffic for this version [1-99]

]

List of version configurations

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

assistant_id Assistant Id (string)required

versions

object[]

required

Array [

version_id Version Id (string)required

Version ID string that references assistant_versions.version_id

percentage Percentage (number)required

Possible values: < 100

Percentage of traffic for this version [1-99]

]

created_at date-timerequired
updated_at date-timerequired

{
  "assistant_id": "string",
  "versions": [
    {
      "version_id": "string",
      "percentage": 0
    }
  ],
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L -X PUT 'https://api.telnyx.com/v2/ai/assistants/:assistant_id/canary-deploys' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "versions": [
    {
      "version_id": "string",
      "percentage": 0
    }
  ]
}'

Response samples

• 200
• 422

---

{
  "assistant_id": "string",
  "versions": [
    {
      "version_id": "string",
      "percentage": 0
    }
  ],
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}