Skip to content
POST/api/v1/gateway/canary

Start a canary deployment

Creates a canary for a project. camelCase body: currentModel + canaryModel (must differ) + optional trafficPercent/minSamples/successThreshold/autoPromote. 409 if a canary is already active. Returns 201.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Request body required

Example

{
  "projectId": "00000000-0000-0000-0000-000000000000",
  "currentModel": "string",
  "canaryModel": "string",
  "trafficPercent": 0,
  "minSamples": 1,
  "successThreshold": 0,
  "autoPromote": false
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "projectId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "currentModel": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "canaryModel": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "trafficPercent": {
          "type": "number",
          "minimum": 0,
          "maximum": 100
        },
        "minSamples": {
          "type": "integer",
          "minimum": 1,
          "maximum": 1000000
        },
        "successThreshold": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "autoPromote": {
          "type": "boolean"
        }
      },
      "required": [
        "projectId",
        "currentModel",
        "canaryModel"
      ],
      "additionalProperties": false
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Created.
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
409An active canary already exists for this project.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/gateway/canary \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "projectId": "00000000-0000-0000-0000-000000000000", "currentModel": "string", "canaryModel": "string", "trafficPercent": 0, "minSamples": 1, "successThreshold": 0, "autoPromote": false }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/gateway/canary", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "projectId": "00000000-0000-0000-0000-000000000000",
    "currentModel": "string",
    "canaryModel": "string",
    "trafficPercent": 0,
    "minSamples": 1,
    "successThreshold": 0,
    "autoPromote": false
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/gateway/canary",
    headers=headers,
    json={
    "projectId": "00000000-0000-0000-0000-000000000000",
    "currentModel": "string",
    "canaryModel": "string",
    "trafficPercent": 0,
    "minSamples": 1,
    "successThreshold": 0,
    "autoPromote": False
},
)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"projectId":"00000000-0000-0000-0000-000000000000","currentModel":"string","canaryModel":"string","trafficPercent":0,"minSamples":1,"successThreshold":0,"autoPromote":false}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/gateway/canary", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403409429500

Other Gateway endpoints