Create Run

POSThttps://api.confident-ai.com/v2/test-runs

Creates a new in-progress test run and returns its id. Use this id as the testRunId when ingesting traces so that each trace becomes one test case in this run, evaluated with metricCollection when one is given.

POST/v2/test-runs

curl -X POST "https://api.confident-ai.com/v2/test-runs" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "metricCollection": "Agent Quality",
  "identifier": "run-399-102"
}'

200

{
  "success": true,
  "data": {
    "id": "<TEST-RUN-ID>"
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/test-runs/<TEST-RUN-ID>/test-cases",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request body

metricCollectionstring
The name of the metric collection used to evaluate the test cases formed from traces ingested into this test run. It must be a single-turn collection.
identifierstring
An optional human-readable identifier for the test run, shown on the Confident AI platform.

Response

Create Run succeeded.

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- idstring
  This is the unique identifier of the created test run. Pass it as testRunId when ingesting traces.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI