Create Run

POST

Create a new Run

This endpoint expects an object.

testset_idintegerOptional

scoring_config_idintegerOptional

statusstringOptionalDefaults to awaiting_execution

model_paramsmap from strings to anyOptional

Optional. The model parameters to use for this run.

sourcestringOptionalDefaults to api

notesstringOptional

prompt_templatestringOptional

metricslist of integersOptional

This endpoint returns an object.

idintegerOptional

created_atdatetimeOptional

The creation date and time of the run.

updated_atdatetimeOptional

The last time the run was updated.

execution_start_timedatetimeOptional

The start time of the run.

execution_end_timedatetimeOptional

The end time of the run.

testset_idintegerOptional

The testset that was executed in this run.

statusstringOptional

The current status of the run.

limit_testcasesintegerOptional

The maximum number of testcases to run.

sourcestringOptional

How the run was created.

model_paramsmap from strings to anyOptional

The model parameters used when generating the run.

notesstringOptional

Notes about the run.

scoring_config_idintegerOptional

The ID of the scoring configuration the run uses.

prompt_templatestringOptional

The prompt template to be used while executing the run.

scoring_start_timedatetimeOptional

The start time of scoring the run’s results.

scoring_end_timedatetimeOptional

The end time of scoring the run’s results.

1	curl -X POST https://api.getscorecard.ai/v1/run \
2	-H "X-API-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"id": 1,
3	"created_at": "2024-01-15T09:30:00Z",
4	"updated_at": "2024-01-15T09:30:00Z",
5	"execution_start_time": "2024-01-15T09:30:00Z",
6	"execution_end_time": "2024-01-15T09:30:00Z",
7	"testset_id": 1,
8	"status": "status",
9	"limit_testcases": 1,
10	"source": "source",
11	"model_params": {
12	"key": "value"
13	},
14	"notes": "notes",
15	"scoring_config_id": 1,
16	"prompt_template": "prompt_template",
17	"scoring_start_time": "2024-01-15T09:30:00Z",
18	"scoring_end_time": "2024-01-15T09:30:00Z"
19	}