runs

Get Run

Return a single run by ID.

get/projects/{project_id}/runs/{run_id}

Path parameters

project_idstring uuid4 required
run_idstring uuid4 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
example_content_idstring nullable
logged_splitsstring[]
logged_inference_namesstring[]

Changes

Changed in 5 of the 15 revisions of this API.75

    • added the new capability_based enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new change_role_to_capability_based enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new create_global enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new create_shared enum value to the //// response property for the response status

      response-property-enum-value-added

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

    • added the new read_unredacted_data enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new read_ai_usage_organization enum value to the //// response property for the response status

      response-property-enum-value-added

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

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

      response-property-enum-value-removed

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

      response-property-enum-value-removed

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

      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

  • 05003e7835a212See the full diff
    • added the new read_ai_usage enum value to the //// response property for the response status

      response-property-enum-value-added

    • the endpoint scheme security ClassicAPIKeyHeader was added to the API

      api-security-added

    • added the optional property to the response with the 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