Start free →

API reference

Tests and model changes

Manage regression suites and run them, or compare models on one; read the reference-set runs waiting for your system when a model changes, and post their results.

All of the API reference

Route summaries and field names are written in English, here and in the file.

/api/v1/regression

GET /api/v1/regression/suites

The workspace's regression suites

Authentication
API key
Key scope
regression:read

POST /api/v1/regression/suites

Create a regression suite

Authentication
API key
Key scope
regression:write
Body
name (required) · description · provider · model · cases (required)

PATCH /api/v1/regression/suites

Change a suite's name, description, provider or model

Authentication
API key
Key scope
regression:write
Parameters
suiteId (required)
Body
name · description · provider · model

DELETE /api/v1/regression/suites

Delete a suite and its runs

Authentication
API key
Key scope
regression:write
Parameters
suiteId (required)

GET /api/v1/regression/runs

The latest regression runs, newest first

Authentication
API key
Key scope
regression:read
Parameters
suiteId

POST /api/v1/regression/runs

Run a suite, or compare 2 to 5 models on it

Authentication
API key
Key scope
regression:write
Body
suiteId (required) · provider · model · checkRunId · commitSha · pullNumber · repoFullName · models (required)

GET /api/v1/regression/runs/{id}

One run, with each case's result

Authentication
API key
Key scope
regression:read
Parameters
id (required)

/api/v1/reference-sets

GET /api/v1/reference-sets/pending

The reference-set runs waiting for your system (model change control)

Authentication
API key
Key scope
usecases:read
Module
Served where the deployment runs FEATURE_MODEL_CHANGE_CONTROL.

POST /api/v1/reference-sets/receipts

Post the results of a reference-set run your system ran

Authentication
API key
Key scope
usecases:write
Module
Served where the deployment runs FEATURE_MODEL_CHANGE_CONTROL.
Body
runId (required) · servedVersion · results (required)