runs

Create Run

Changed on

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

Request

  • Base URL
    https://api.galileo.ai
  • URL
    https://api.galileo.ai/projects/{project_id}/runs
  • Auth
    • API key in header Splunk-AO-API-Key
    • or API key in header Galileo-API-Key
    • or OAuth 2
      Password
      Token URL: https://api.galileo.ai/login
    • or HTTP basic

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 | 19

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

  • 8cb1daec06e2Revision changes
    • warning

      added the new 19.00 enum value to the / response property for the response status

  • 933e8c8e6366Revision changes
    • info

      removed the 12.00 enum value from the / response property for the response status

    • info

      removed the 7.00 enum value from the / response property for the response status

    • info

      removed the 9.00 enum value from the / response property for the response status