Skip to main content
PUT
Update Evaluation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

evaluation_id
string
required

Body

application/json

Request to update an existing evaluation

name
string | null

Name of the evaluation

description
string | null

Description of the evaluation

tags
string[] | null

Tags for categorization

metadata
Metadata · object | null

Additional metadata

metrics
Metrics · object | null

High-level metrics summary

model_name
string | null

Model name

dataset
string | null

Dataset name

framework
string | null

Framework used

task_type
string | null

Type of task

inference_model
string | null

Prime Inference model ID

eval_config
HostedEvalConfig · object | null

Hosted evaluation configuration

is_public
boolean | null

Whether the evaluation is publicly shareable by link; setting true without show_on_leaderboard keeps it off leaderboards by default

show_on_leaderboard
boolean | null

Whether this public evaluation appears on environment leaderboards

Response

Successful Response

Response after updating an evaluation

evaluation_id
string
required
name
string
required
status
enum<string>
required

Evaluation status enum

Available options:
PENDING,
RUNNING,
PROCESSING,
COMPLETED,
FAILED,
TIMEOUT,
CANCELLED
updated_at
string<date-time>
required