Skip to main content
GET
/
api
/
agents
/
{id}
Get evaluation agent
curl --request GET \
  --url https://agent-evalserver-production.up.railway.app/api/agents/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "2f7e9c9c-9a2e-4e3a-b77f-6d9d1a7e3a11",
  "name": "Support bot evaluation",
  "seed": 123,
  "numNodes": 100,
  "publicUrl": "https://example.com/chat",
  "advancedPayload": null,
  "label": "eval",
  "created_at": "2026-06-02T15:00:00Z",
  "updated_at": "2026-06-02T15:00:00Z"
}

Authorizations

x-api-key
string
header
required

Platform API key for authenticated account-level API access

Path Parameters

id
string<uuid>
required

Evaluation agent ID returned by Create evaluation agent.

Response

Evaluation agent

Evaluation agent registered in Rippletide. This record tells Rippletide what external agent endpoint to test and how to store evaluation results.

name
string
required

Human-readable name for this evaluation agent.

Example:

"Support bot evaluation"

seed
integer
required

Deterministic seed used by the evaluation setup. Use any integer; the CLI generates one automatically.

Example:

123

numNodes
integer
default:100
required

Evaluation graph size hint. Use 100 unless the Rippletide team recommends another value.

Example:

100

id
string<uuid>

Unique agent identifier returned by Rippletide. Use this ID in later evaluation API calls.

Example:

"2f7e9c9c-9a2e-4e3a-b77f-6d9d1a7e3a11"

publicUrl
string<uri> | null

Public HTTPS endpoint for the agent Rippletide should evaluate.

Example:

"https://example.com/chat"

advancedPayload
object

Optional request payload template used when Rippletide calls the agent endpoint. Omit this for standard chat-style APIs.

Example:
{
"payload": "{\"message\":\"[eval-question]\"}"
}
label
enum<string>
default:eval

Public integrations should use eval.

Available options:
eval
Example:

"eval"

created_at
string<date-time>

Creation timestamp.

Example:

"2026-06-02T15:00:00Z"

updated_at
string<date-time>

Last update timestamp.

Example:

"2026-06-02T15:05:00Z"