Skip to main content
PATCH
Update Eval Definition

Authorizations

X-Lightsage-Api-Key
string
header
required

Path Parameters

eval_id
string
required

Body

application/json
custom_prompt
string
expected_behavior
string
starting_project_id
string

Starting project to clone before running the eval. Empty string clears it.

docs_mode
enum<string>

Docs behavior for this eval: default, include, or exclude.

Available options:
default,
include,
exclude
include_env_vars
boolean

Include configured environment variable names in the eval prompt.

env_profile_ids
string[] | null

Environment profile IDs to use for this eval. Empty list clears the selection.

model_ids
string[] | null

Model IDs to use for this eval. Empty list uses the config-level models.

compare_skills
boolean
skills_mode
enum<string>
Available options:
none,
all,
selected
skill_ids
string[] | null

Selected skill IDs. Used when skills_mode is selected.

mcp_enabled
boolean
run_context
Run Context · object | null
enabled
boolean

Response

Successful Response

id
string
required
operation_id
string
required
eval_type
string
required
source_id
string | null
source
PublicApiPerformanceSourceRef · object | null
prompt
string | null
custom_prompt
string | null
expected_behavior
string | null
starting_project_id
string | null
docs_mode
enum<string>
default:default
Available options:
default,
include,
exclude
include_env_vars
boolean
default:true
env_profile_ids
string[]
model_ids
string[]
compare_skills
boolean
default:false
skills_mode
enum<string>
default:none
Available options:
none,
all,
selected
skills_enabled
boolean
default:false
skill_ids
string[]
mcp_enabled
boolean
default:false
run_context
Run Context · object
enabled
boolean
default:true