Delete system - Scorecard AI Docs

DELETE

/

systems

/

{systemId}

import Scorecard from 'scorecard-ai';

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

async function main() {
  const system = await client.systems.delete('12345678-0a8b-4f66-b6f3-2ddcfa097257');

  console.log(system.success);
}

main();

{
  "success": true
}

Authorizations

Authorization

string

header

required

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

Path Parameters

systemId

string

required

The ID of the system to delete.

Example:

"12345678-0a8b-4f66-b6f3-2ddcfa097257"

Response

200

application/json

System deleted successfully

The response is of type object.

Create system configurationCreate a new configuration for a system. Each configuration contains specific parameter values that match the system's configSchema - things like model parameters, thresholds, or processing options. Once created, configurations cannot be modified, ensuring stable reference points for evaluations. When creating a configuration: - The 'config' object is validated against the parent system's configSchema - Configurations with validation errors are still stored, with errors included in the response - Validation errors indicate fields that don't match the schema but don't prevent creation - Having validation errors may affect how some evaluation metrics are calculated

import Scorecard from 'scorecard-ai';

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

async function main() {
  const system = await client.systems.delete('12345678-0a8b-4f66-b6f3-2ddcfa097257');

  console.log(system.success);
}

main();

{
  "success": true
}