Project data modelsTest Runs

Create Test Run

Creates a new in-progress test run and returns its id. Use this id as the testRunId when ingesting traces (POST /v1/traces) so that each trace becomes one test case in this run.

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request

metricCollectionstringOptional
This is the metric collection used to evaluate the test cases formed from traces ingested into this test run.
identifierstringOptional

This is an optional human-readable identifier for the test run, shown on the Confident AI platform.

Response

The created test run id.
successboolean
A boolean indicating the success or failure of the API call
dataobject
This maps to the test run id.
deprecatedboolean
This is true if this endpoint is deprecated.