Skip to main content
POST
Create Evaluation

Authorizations

Authorization
string
header
required

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

Body

application/json

Request to create a new evaluation

name
string
required

Name of the evaluation

team_id
string | null

Team ID if creating evaluation for a team

environments
EnvironmentReference · object[] | null

List of environment references with optional version IDs

suite_id
string | null

Suite ID if this evaluation is part of a suite

run_id
string | null

Run ID for Prime RL runs (optional)

is_hosted
boolean
default:false

Whether this is a hosted evaluation

inference_model
string | null

Prime Inference model ID

eval_config
HostedEvalConfig · object | null

Hosted evaluation configuration

model_name
string | null

Model name

dataset
string | null

Dataset name

framework
string | null

Framework used (e.g., 'prime-rl', 'openai/evals')

task_type
string | null

Type of task (e.g., 'classification', 'generation')

description
string | null

Description of the evaluation

tags
string[]

Tags for categorization

metadata
Metadata · object | null

Additional metadata

metrics
Metrics · object | null

High-level metrics summary

is_public
boolean
default:false

Whether this evaluation is publicly shareable by link

show_on_leaderboard
boolean
default:false

Whether this public evaluation appears on environment leaderboards

Response

Successful Response

Response after creating an evaluation

evaluation_id
string
required

ID of the created evaluation

name
string
required
status
enum<string>
required

Evaluation status enum

Available options:
PENDING,
RUNNING,
PROCESSING,
COMPLETED,
FAILED,
TIMEOUT,
CANCELLED
eval_type
enum<string>
required

Type: 'prime_rl', 'environment', or 'suite'

Available options:
suite,
training,
environment
created_at
string<date-time>
required
environment_ids
string[] | null
suite_id
string | null
run_id
string | null
version_id
string | null
viewer_url
string | null