Skip to content
PUT/api/v1/gateway

Update per-org gateway routing config

Upserts the caller's org gateway_routing_config row. orgId is REQUIRED (drives the org-membership + admin role gate). routingStrategy enum extended with quality-cost + thompson learned strategies.

Authentication

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

Request body required

Example

{
  "routingStrategy": "priority",
  "enabled": false,
  "cacheEnabled": false,
  "cacheTtlSec": 0,
  "rateLimitEnabled": false,
  "requestsPerMinute": 0,
  "tokensPerMinute": 0,
  "circuitBreakerEnabled": false,
  "providers": [
    {
      "name": "string",
      "enabled": false,
      "weight": 0,
      "priority": 0,
      "models": [
        "string"
      ]
    }
  ],
  "orgId": "00000000-0000-0000-0000-000000000000"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "routingStrategy": {
          "type": "string",
          "enum": [
            "priority",
            "round-robin",
            "weighted",
            "least-latency",
            "least-cost",
            "least-load",
            "random",
            "quality-cost",
            "thompson"
          ]
        },
        "enabled": {
          "type": "boolean"
        },
        "cacheEnabled": {
          "type": "boolean"
        },
        "cacheTtlSec": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2592000
        },
        "rateLimitEnabled": {
          "type": "boolean"
        },
        "requestsPerMinute": {
          "type": "integer",
          "minimum": 0,
          "maximum": 1000000
        },
        "tokensPerMinute": {
          "type": "integer",
          "minimum": 0,
          "maximum": 1000000000
        },
        "circuitBreakerEnabled": {
          "type": "boolean"
        },
        "providers": {
          "maxItems": 50,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "enabled": {
                "type": "boolean"
              },
              "weight": {
                "type": "number",
                "minimum": 0,
                "maximum": 100
              },
              "priority": {
                "type": "integer",
                "minimum": 0,
                "maximum": 1000
              },
              "models": {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                }
              }
            },
            "required": [
              "name"
            ],
            "additionalProperties": false
          }
        },
        "orgId": {
          "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)$"
        }
      },
      "required": [
        "orgId"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Updated routing config.
400(no description)
401(no description)
403Forbidden - insufficient role for this operation.
429(no description)

Code samples

cURL

curl -X PUT \
  https://evalguard.ai/api/v1/gateway \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "routingStrategy": "priority", "enabled": false, "cacheEnabled": false, "cacheTtlSec": 0, "rateLimitEnabled": false, "requestsPerMinute": 0, "tokensPerMinute": 0, "circuitBreakerEnabled": false, "providers": [ { "name": "string", "enabled": false, "weight": 0, "priority": 0, "models": [ "string" ] } ], "orgId": "00000000-0000-0000-0000-000000000000" }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "PUT",
  path: "/api/v1/gateway",
  body: {
    "routingStrategy": "priority",
    "enabled": false,
    "cacheEnabled": false,
    "cacheTtlSec": 0,
    "rateLimitEnabled": false,
    "requestsPerMinute": 0,
    "tokensPerMinute": 0,
    "circuitBreakerEnabled": false,
    "providers": [
      {
        "name": "string",
        "enabled": false,
        "weight": 0,
        "priority": 0,
        "models": [
          "string"
        ]
      }
    ],
    "orgId": "00000000-0000-0000-0000-000000000000"
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="PUT",
    path="/api/v1/gateway",
    body={
    "routingStrategy": "priority",
    "enabled": False,
    "cacheEnabled": False,
    "cacheTtlSec": 0,
    "rateLimitEnabled": False,
    "requestsPerMinute": 0,
    "tokensPerMinute": 0,
    "circuitBreakerEnabled": False,
    "providers": [
        {
            "name": "string",
            "enabled": False,
            "weight": 0,
            "priority": 0,
            "models": [
                "string"
            ]
        }
    ],
    "orgId": "00000000-0000-0000-0000-000000000000"
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"routingStrategy":"priority","enabled":false,"cacheEnabled":false,"cacheTtlSec":0,"rateLimitEnabled":false,"requestsPerMinute":0,"tokensPerMinute":0,"circuitBreakerEnabled":false,"providers":[{"name":"string","enabled":false,"weight":0,"priority":0,"models":["string"]}],"orgId":"00000000-0000-0000-0000-000000000000"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PUT", "https://evalguard.ai/api/v1/gateway", 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

400401403429

Other Gateway endpoints