Sign in
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_type13 | 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

Changes

Changed in 2 of the 14 revisions of this API.6

  • 933e8c8e63663See the full diff
    • ○

      removed the 12.00 enum value from the task_type/anyOf[subschema #1: TaskType]/ response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the 7.00 enum value from the task_type/anyOf[subschema #1: TaskType]/ response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the 9.00 enum value from the task_type/anyOf[subschema #1: TaskType]/ response property for the response status 200

      response-property-enum-value-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 05003e7835a23See the full diff
    • ○

      the endpoint scheme security ClassicAPIKeyHeader was added to the API

      api-security-added

    • ○

      added the new optional request property prompt_template_version_id

      new-optional-request-property

    • ○

      added the optional property prompt_template_version_id to the response with the 200 status

      response-optional-property-added

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog