PATCH
/
runs
/
{runId}
import Scorecard from 'scorecard-ai';

const client = new Scorecard({
  bearerToken: process.env['SCORECARD_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const run = await client.runs.update('135', { status: 'awaiting_scoring' });

  console.log(run.id);
}

main();
{
  "id": "135",
  "status": "awaiting_scoring"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

runId
string
required

The ID of the Run to update.

Example:

"135"

Body

application/json
status
enum<string>
required

The status of the Run.

Available options:
pending,
awaiting_execution,
running_execution,
awaiting_scoring,
running_scoring,
awaiting_human_scoring,
completed

Response

200
application/json
Run updated successfully
id
string
required

The ID of the Run.

status
enum<string>
required

The status of the Run.

Available options:
pending,
awaiting_execution,
running_execution,
awaiting_scoring,
running_scoring,
awaiting_human_scoring,
completed