Skip to content
GET/api/v1/simulator/personas

List simulator personas

Lists simulator personas visible to a project: the platform seed personas plus the project's own custom ones, seed-first then newest. `?projectId` is required and must be a UUID (400). Each row is `{id, name, archetype, system_prompt, goals, constraints, persona_metadata, is_seed, created_at}` — `goals` and `constraints` are string arrays that shape the simulated conversation. `archetype` is one of `angry_customer`, `confused_newbie`, `edge_case_probe`, `expert_tester`, `child_safety`, `social_engineer`, `rapid_topic_shift`, `multilingual`, `compliance_auditor`, `custom`. Capped at 100 rows. 60 req/min.

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

200Personas.
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.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

curl -X GET \
  https://evalguard.ai/api/v1/simulator/personas \
  -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/simulator/personas", {
  method: "GET",
  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("GET", "https://evalguard.ai/api/v1/simulator/personas", headers=headers)
print(response.status_code, response.json())

Go

package main

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

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "GET", "https://evalguard.ai/api/v1/simulator/personas", 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

400401403429500

Other Evals endpoints