Skip to content
POST/api/v1/resume

Resume a paused/failed run

Re-runs the unsuccessful cases of an existing EVAL run and folds the improved results back into it. Body: `runId` (required, 404 if unknown), optional `retryStrategy` (`failed-only` default | `failed-and-errors` | `all`) and `maxRetries` (1-10, default 3). Security scans are not supported. The run's project is resolved server-side and org membership verified before anything is read; the lookup and the update are both pinned to `id` + that project. Requires a BYOK provider key for the run's model (400 NO_PROVIDER_KEY / 400 UNSUPPORTED_MODEL); provider calls run behind a per-(provider, org) circuit breaker that returns 503 CIRCUIT_OPEN while tripped. Returns `{runId, retriedCases, originalPassRate, improvedPassRate, score, maxScore, cases}`. Rate-limited to 10/min and audit-logged. NOT idempotent — the `Idempotency-Key` header is not honoured on this path, so a retry re-runs the cases.

Authentication

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

Response

200 example

{
  "success": true
}

All status codes

200Resumed.
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.
404Not Found — NOT_FOUND.
409Conflict — CONFLICT.
429(no description)
500Internal Server Error — DB_ERROR, RESUME_ERROR.
503Service Unavailable — CIRCUIT_OPEN.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/resume \
  -H "Authorization: Bearer $EVALGUARD_API_KEY"

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/resume", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}` },
});
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']}"}

response = requests.request("POST", "https://evalguard.ai/api/v1/resume", headers=headers)
print(response.status_code, response.json())

Go

package main

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

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/resume", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403404409429500503

Other Evals endpoints