Skip to main content
POST
Register an evaluation run
The TraceRoot SDKs call this endpoint for you; call it directly only where no SDK fits. It accepts a project API key only.

Authorizations

Authorization
string
header
required

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

Body

application/json

Register/start a run. Idempotent on client_run_id within an evaluation.

candidate_version
string
required
Required string length: 1 - 200
dataset_id
string
required
Required string length: 1 - 64
evaluation_name
string
required
Required string length: 1 - 200
baseline_run_id
string | null
Required string length: 1 - 64
case_count
integer | null
Required range: 0 <= x <= 9007199254740991
client_run_id
string | null
Required string length: 1 - 128
dataset_version_id
string | null
Required string length: 1 - 64
environment
string
default:evaluation
Required string length: 1 - 64
evaluation_key
string | null
Required string length: 1 - 200
metadata
Metadata · object | null
scorers
ScorerRef · object[]
Maximum array length: 200

Response

Successful Response

dataset_version_id
string
required
evaluation_id
string
required
evaluation_run_id
string
required
run_number
integer
required
run_path
string
required
run_url
string
required