Sign in

v4

latestOpenAPI 3.1.02026-08-019681,1012.0 MB
runs

Create Run

Create a new run in the given project.

Validates that no run with the same name exists, that the run's task type is compatible with the project type, and that all existing runs share the same task type before delegating to the async run-creation service.

post/projects/{project_id}/runs

Path parameters

project_idstring uuid4 required

Request body

namestring required
project_idstring uuid4 nullable
created_bystring uuid4 nullable
num_samplesinteger nullable
winnerboolean nullable
dataset_hashstring nullable
dataset_version_idstring uuid4 nullable
prompt_template_version_idstring uuid4 nullable
task_typeinteger required

Response

Successful Response

namestring nullable
project_idstring uuid4 nullable
created_bystring uuid4 required
num_samplesinteger required
winnerboolean required
dataset_hashstring nullable
dataset_version_idstring uuid4 nullable
prompt_template_version_idstring uuid4 nullable
idstring uuid4 required
created_atstring date-time required
updated_atstring date-time required
task_type7 | 9 | 12 | 13 | 15 | 16 | 17 | 18

Valid task types for modeling.

We store these as ints instead of strings because we will be looking this up in the database frequently.

last_updated_bystring uuid4 required