Skip to main content
POST
/
v1
/
run
/
{id}
/
evaluations
Create evaluation for a run
curl --request POST \
  --url https://api.example.com/v1/run/{id}/evaluations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "evaluation_label_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "value": 123,
  "output_name": "<string>",
  "field_path": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "<string>",
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "evaluation_label_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "value": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "output_name": "<string>",
  "field_path": "<string>",
  "created_by": "<string>",
  "created_by_evaluator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_by": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}
Create a new evaluation for a specific run. The evaluation must be associated with an evaluation label that defines the type and constraints of the evaluation value.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

The ID of the run

Body

application/json
​
evaluation_label_id
string<uuid>
required
​
value
number
required
​
output_name
string
​
field_path
string

Response

Evaluation created successfully

​
id
string<uuid>
required

Unique identifier for the run evaluation

​
account_id
string
required

ID of the account that owns this evaluation

​
run_id
string<uuid>
required

ID of the run being evaluated

​
evaluation_label_id
string<uuid>
required

ID of the evaluation label used

​
value
number
required

The evaluation value

​
created_at
string<date-time>
required

When the evaluation was created

​
output_name
string | null

Name of the output being evaluated

​
field_path
string | null

JSON path to the specific field being evaluated

​
created_by
string | null

ID of the user who created the evaluation

​
created_by_evaluator_id
string<uuid> | null

ID of the evaluator that created this evaluation

​
updated_by
string | null

ID of the user who last updated the evaluation

​
updated_at
string<date-time>

When the evaluation was last updated