Start a canary rollout for a candidate version
Start a persisted canary rollout advancing a candidate agent version through a traffic-stage ladder (default stages 5 → 25 → 50 → 100 percent; overridable via stages). Refuses with 409 when the agent already has an active rollout — cancel or roll it back first. The candidate and (if supplied) baseline version ids must belong to this agent or the request 422s. POST /canary-rollout/evaluate drives stage advance / rollback; POST …/rollback and POST …/cancel stop it.
Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Path Parameters
Response
Successful response.