Set or replace a staged rollout
PUT/v1/projects/:project_id/agents/:agent_id/release
Starts serving two archived versions side by side: canary_percent of traffic gets canary_version, the rest gets stable_version.
Assignment is deterministic — it hashes the actor behind the request's session (falling back to the session itself), so one end user never flip-flops between configs mid-conversation. Requests with neither are split randomly.
While a release is active the agent's live columns act as a draft: further edits archive new versions but do not disturb either side of the running split. End the rollout with promote or abort.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 413
- 429
- 500
- 502
- 4XX
The agent, with its active release set
Bad Request — malformed input, or a version that does not exist
Unauthorized
Forbidden
Agent not found
REQUEST_REJECTED — the request body is over the size the body parser accepts
QUOTA_EXCEEDED — a requests quota on the calling API key or its project is spent for the window; Retry-After says when it reopens
Response Headers
Seconds until the quota window admits a request again
Unexpected server error — INTERNAL_ERROR, with the raw message never forwarded
The deployment's admission service is asked about this write and did not answer — ADMISSION_UNAVAILABLE; the write did not happen
The deployment's admission service refused this write — answered under the service's own 4xx status, with its code (matching ^[A-Za-z_][A-Za-z0-9_]{0,63}$, not necessarily an ERROR_CODES key), message and meta; the write did not happen. A status this operation also declares on its own is documented there