Skip to content
POST/api/v1/playground/replay

Execute trace replay with overrides

Re-executes a trace with optional model/prompt/temperature overrides and returns a diff.

Authentication

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

Request body required

Example

{
  "traceId": "00000000-0000-0000-0000-000000000000",
  "overrides": {
    "model": "string",
    "systemPrompt": "string",
    "temperature": 0,
    "maxTokens": 1,
    "messages": [
      {
        "role": "string",
        "content": "string"
      }
    ]
  }
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "traceId": {
          "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)$"
        },
        "overrides": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string",
              "maxLength": 200
            },
            "systemPrompt": {
              "type": "string",
              "maxLength": 50000
            },
            "temperature": {
              "type": "number",
              "minimum": 0,
              "maximum": 2
            },
            "maxTokens": {
              "type": "integer",
              "minimum": 1,
              "maximum": 128000
            },
            "messages": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "role": {
                    "type": "string"
                  },
                  "content": {
                    "type": "string"
                  }
                },
                "required": [
                  "role",
                  "content"
                ],
                "additionalProperties": false
              }
            }
          },
          "additionalProperties": {}
        }
      },
      "required": [
        "traceId"
      ],
      "additionalProperties": false
    }
  }
}

Response

All status codes

200Replay result with diff comparison
400Bad Request.
401Unauthorized — no valid credential was presented (AUTH_REQUIRED).
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
404Not Found — NOT_FOUND.
429Too Many Requests — the per-key or per-organization rate limit was exceeded. Honour the Retry-After header.
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).
502Bad Gateway — REPLAY_GATEWAY_FAILED.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/playground/replay \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "traceId": "00000000-0000-0000-0000-000000000000", "overrides": { "model": "string", "systemPrompt": "string", "temperature": 0, "maxTokens": 1, "messages": [ { "role": "string", "content": "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/playground/replay", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "traceId": "00000000-0000-0000-0000-000000000000",
    "overrides": {
      "model": "string",
      "systemPrompt": "string",
      "temperature": 0,
      "maxTokens": 1,
      "messages": [
        {
          "role": "string",
          "content": "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(
    "POST",
    "https://evalguard.ai/api/v1/playground/replay",
    headers=headers,
    json={
    "traceId": "00000000-0000-0000-0000-000000000000",
    "overrides": {
        "model": "string",
        "systemPrompt": "string",
        "temperature": 0,
        "maxTokens": 1,
        "messages": [
            {
                "role": "string",
                "content": "string"
            }
        ]
    }
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"traceId":"00000000-0000-0000-0000-000000000000","overrides":{"model":"string","systemPrompt":"string","temperature":0,"maxTokens":1,"messages":[{"role":"string","content":"string"}]}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/playground/replay", 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

400401403404429500502

Other Playground endpoints