Skip to main content
PATCH
Update Eval

Authorizations

X-Lightsage-Api-Key
string
header
required

Path Parameters

eval_id
string
required

Body

application/json
name
string
Required string length: 1 - 160
prompts
string[] | null

Buying or build questions the agent answers by choosing between your company and the competitor. CLI clients expose this as repeatable --prompt.

Required array length: 1 - 20 elements
agent
string[] | null

Runnable agents from GET /v2/agents. An empty array saves the comparison without default agents. CLI clients expose repeatable --agent.

Maximum array length: 10
persona
string

Set to null to clear the saved persona.

Maximum string length: 160
search_grounding
enum<string> | null

Requested web-retrieval behavior for an eval run.

Available options:
disabled,
enabled,
default
runs
integer
Required range: 1 <= x <= 20
tags
string[] | null
Maximum array length: 20

Response

Successful Response

id
string
required

Eval ID. Pass it as eval_id to POST /v2/eval-runs to run the comparison.

name
string
required
competitor
V2AgentPreferenceCompetitor · object | null

The competitor your company is compared against. Null when the competitor is no longer tracked.

prompts
string[]
judges
string[]

Criteria applied to each response. The first one decides which company the agent recommended and cannot be changed.

agent
string[]
persona
string | null
search_grounding
enum<string>
default:default

Requested web-retrieval behavior for an eval run.

Available options:
disabled,
enabled,
default
runs
integer
default:1
Required range: 1 <= x <= 20
tags
string[]
created_at
string | null
updated_at
string | null