---
title: "Get Canary Deploy"
method: GET
path: "/ai/assistants/{assistant_id}/canary-deploys"
tags: ["Assistants"]
---

# Get Canary Deploy

`GET /ai/assistants/{assistant_id}/canary-deploys`

## Request

- Base URL: `https://api.telnyx.com/v2`
- URL: `https://api.telnyx.com/v2/ai/assistants/{assistant_id}/canary-deploys`
- Auth: HTTP bearer

Endpoint to get a canary deploy configuration for an assistant.

Retrieves the current canary deploy configuration with all version IDs and their
traffic percentages for the specified assistant.

## Path parameters

- `assistant_id` string, required

## Response `200`

Successful Response

- CanaryDeployResponse: Response shape. Always carries ``rules`` (canonical).
  - `assistant_id` string, required
  - `rules` RuleOutput[], required
    - `match` Clause[]
      - `attribute` string, required: Attribute name from the routing context
      - `operator` 'in' | 'not_in' | 'starts_with', required
      - `values` string[], required
    - `serve` Serve, required: What a rule serves when matched. Exactly one of: - ``version_id`` — serve a specific version - ``rollout`` — weighted random across versions; weights must sum to less than 100, with the leftover routing to the main version
      - `version_id` string
      - `rollout` RolloutSlot[]
        - `version_id` string, required
        - `weight` number, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-05-08** `30cb1ddce91b`: 1 breaking, 1 info
  - removed the required property `versions` from the response with the `200` status
  - added the required property `rules` to the response with the `200` status

[Operation history](https://skmtc.dev/team-telnyx/apis/telnyx-api/changes/ai/assistants/:assistant_id/canary-deploys/get.md)

---

[API](https://skmtc.dev/team-telnyx/apis/telnyx-api.md) - [All operations](https://skmtc.dev/team-telnyx/apis/telnyx-api/llms.txt) - [OpenAPI document](https://skmtc.dev/team-telnyx/apis/telnyx-api/revisions/0f17b8167873?raw)