Skip to content
PATCH/api/v1/eval-schedules

Update a scheduled eval

Updates a schedule by id (404 if not found). All non-id fields optional; re-validates cronExpression when present.

Authentication

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

Request body required

Example

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "description": "string",
  "config": {},
  "datasetId": "00000000-0000-0000-0000-000000000000",
  "baselineRunId": "00000000-0000-0000-0000-000000000000",
  "alertOnScoreDrop": 0,
  "alertOnFailure": false,
  "enabled": false,
  "cronExpression": "string"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "id": {
          "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)$"
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "description": {
          "nullable": true,
          "type": "string",
          "maxLength": 2000
        },
        "config": {
          "type": "object",
          "additionalProperties": {}
        },
        "datasetId": {
          "nullable": true,
          "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)$"
        },
        "baselineRunId": {
          "nullable": true,
          "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)$"
        },
        "alertOnScoreDrop": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "alertOnFailure": {
          "type": "boolean"
        },
        "enabled": {
          "type": "boolean"
        },
        "cronExpression": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Updated schedule.
400(no description)
401(no description)
403Forbidden - insufficient role for this operation.
404(no description)
409Conflict — CONFLICT.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

curl -X PATCH \
  https://evalguard.ai/api/v1/eval-schedules \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "id": "00000000-0000-0000-0000-000000000000", "name": "string", "description": "string", "config": {}, "datasetId": "00000000-0000-0000-0000-000000000000", "baselineRunId": "00000000-0000-0000-0000-000000000000", "alertOnScoreDrop": 0, "alertOnFailure": false, "enabled": false, "cronExpression": "string" }'

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/eval-schedules", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string",
    "config": {},
    "datasetId": "00000000-0000-0000-0000-000000000000",
    "baselineRunId": "00000000-0000-0000-0000-000000000000",
    "alertOnScoreDrop": 0,
    "alertOnFailure": false,
    "enabled": false,
    "cronExpression": "string"
  }),
});
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(
    "PATCH",
    "https://evalguard.ai/api/v1/eval-schedules",
    headers=headers,
    json={
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string",
    "config": {},
    "datasetId": "00000000-0000-0000-0000-000000000000",
    "baselineRunId": "00000000-0000-0000-0000-000000000000",
    "alertOnScoreDrop": 0,
    "alertOnFailure": False,
    "enabled": False,
    "cronExpression": "string"
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"id":"00000000-0000-0000-0000-000000000000","name":"string","description":"string","config":{},"datasetId":"00000000-0000-0000-0000-000000000000","baselineRunId":"00000000-0000-0000-0000-000000000000","alertOnScoreDrop":0,"alertOnFailure":false,"enabled":false,"cronExpression":"string"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PATCH", "https://evalguard.ai/api/v1/eval-schedules", 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

400401403404409429500

Other Evals endpoints