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
Required array length: 1 - 20 elements
judges
string[] | null

Replacement success criteria for the eval.

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

Replacement eval persona. Pass null to clear it; omit it to leave the saved value unchanged.

Maximum string length: 160
clis
string[] | null

Replacement saved CLI IDs or shell installation commands. UUID values resolve saved CLIs; every other value is an installation command. Pass an empty array to clear all CLIs.

Maximum array length: 20
mcps
(V2SavedMcpReference · object | V2InlineMcpDefinition · object)[] | null
Maximum array length: 20
setup_commands
string[] | null

Replacement setup commands. Pass an empty array to clear all saved setup commands.

Maximum array length: 20
cleanup_commands
string[] | null

Replacement cleanup commands. Pass an empty array to clear all saved cleanup commands.

Maximum array length: 20
search_grounding
enum<string> | null

Replacement web-retrieval policy. Omit it to keep the saved value.

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

Replacement labels for the eval. Pass an empty array to clear all tags.

Maximum array length: 20

Response

Successful Response

id
string
required
name
string
required
prompts
string[]
judges
string[]
agent
string[]
persona
string | null
clis
(V2SavedCliReference · object | V2InlineCliReference · object)[]
mcps
(V2SavedMcpReference · object | V2InlineMcpDefinition · object)[]
setup_commands
string[]
cleanup_commands
string[]
search_grounding
enum<string>
default:default

Saved web-retrieval policy: disabled, enabled, or default.

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