Skip to main content
PATCH
Update Eval Agent

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
The unique identifier of the eval agent to update.

Body Parameters

string
New display name for the eval agent. Between 1 and 200 characters.
string | null
Updated description, or null to clear it.
string | null
Repoint the published version to this version ID. Pass null to unpublish the agent.
object
Key-value metadata to associate with the eval agent. Values must be strings. Replaces the existing metadata object.
This endpoint updates agent-level fields only. To edit prompts, levels, or targets, update the agent’s draft version using the Update Eval Agent Version endpoint.

Response

object
The updated eval agent.
string
Unique identifier for the eval agent.
string
ID of the organization that owns this eval agent.
string
Unique slug key for the eval agent within the organization.
string
Display name of the eval agent.
string | null
Description of what the eval agent grades, or null.
string
ID of the current editable draft version.
string | null
ID of the published version, or null if unpublished.
object
Updated key-value metadata. Values are strings.
string
ISO 8601 timestamp for when the eval agent was created.
string
ISO 8601 timestamp for when the eval agent was last updated.
string | null
ISO 8601 timestamp if the eval agent has been soft-deleted, otherwise null.
object
The current editable draft version of the eval agent.
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
Optional description of this version.
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
Verdict levels for graded mode. Empty array for pass/fail mode.
array of strings
Which level keys count as a target match.
number
Relative weight of this agent in aggregate scoring. 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.