Skip to main content
PATCH
Update Eval Agent Version

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
The unique identifier of the eval agent.
string
required
The unique identifier of the version to update. Must be in the editable state.

Body Parameters

string
Updated display name for this version. Between 1 and 200 characters.
string | null
Updated description, or null to clear it.
string
The modality for this version. One of text or audio.
string
Updated system prompt for the judge LLM, in Markdown. Maximum 8000 characters.
string
Updated grading prompt for the judge LLM, in Markdown. Maximum 8000 characters.
array of objects
Verdict levels for graded mode. Pass an empty array for pass/fail mode. Maximum 5 levels. Each level object requires:
  • level_key (string, 1-64 characters): unique key within this version.
  • label (string, 1-80 characters): display label shown in results.
  • prompt_md (string): description used in the grading prompt.
  • color (string, optional): one of rose, amber, gold, emerald, blue, indigo, violet, fog.
array of strings
Which level keys count as a target match. Must be empty for pass/fail agents. Every key listed must match a defined level.
number
Relative weight of this agent in aggregate scoring. Between 0 and 100.

Response

string
Unique identifier for this version.
string
ID of the organization that owns this version.
string
ID of the parent eval agent.
integer
Sequential version number.
string
Name of this version.
string | null
Description of this version, or null.
string
State of this version. One of editable or archived.
string
One of text or audio.
string
The system prompt for the judge LLM, in Markdown.
string
The grading prompt for the judge LLM, in Markdown.
array of objects
Updated verdict levels. Each level contains level_key, label, prompt_md, and optionally color.
array of strings
Updated target level keys.
number
Updated weight. Between 0 and 100.
string | null
ID of the version this was forked from, or null.
string | null
Identifier of the user who created this version, or null.
string
ISO 8601 timestamp for when this version was created.
string
ISO 8601 timestamp for when this version was last updated.