SCscorecard-ai

Create Run

Changed on

Create a new Run.

post/projects/{projectId}/runs

Request

  • Base URL
    https://api2.scorecard.io/api/v2
  • Auth
    HTTP bearer

Path parameters

projectIdstring required
Example:314

The ID of the Project.

Request body

testsetIdstring nullable

The ID of the Testset this Run is testing.

systemVersionIdstring uuid nullable

The ID of the system version this Run is using.

metricIdsstring[] required

The IDs of the metrics this Run is using.

Response

Run created successfully

idstring required

The ID of the Run.

testsetIdstring nullable required

The ID of the Testset this Run is testing.

systemIdstring uuid nullable required

The ID of the system this Run is using.

systemVersionIdstring uuid nullable required

The ID of the system version this Run is using.

metricIdsstring[] required

The IDs of the metrics this Run is using.

metricVersionIdsstring[] required

The IDs of the metric versions this Run is using.

numRecordsnumber required

The number of records in the Run.

numExpectedRecordsnumber nullable required

The number of expected records in the Run. Determined by the number of testcases in the Run's Testset at the time of Run creation.

numScoresnumber required

The number of completed scores in the Run so far.

status'pending' | 'awaiting_execution' | 'running_execution' | 'awaiting_scoring' | 'running_scoring' | 'awaiting_human_scoring' | 'completed' required

The status of the Run.

Changes

  • 47c2214e7180Revision changes
    • breaking

      the response property became nullable for the status

    • info

      the request property became nullable

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • f8f811fe2ec9Revision changes
    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status