GET
/
systems
/
{systemId}
/
configs
/
{systemConfigId}
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 systemConfig = await client.systemConfigs.get('87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0', {
    systemId: '12345678-0a8b-4f66-b6f3-2ddcfa097257',
  });

  console.log(systemConfig.id);
}

main();
{
  "id": "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0",
  "systemId": "12345678-0a8b-4f66-b6f3-2ddcfa097257",
  "name": "Production (Low Temperature)",
  "config": {
    "temperature": 0.1,
    "maxTokens": 1024,
    "model": "gpt-4-turbo"
  }
}

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 the configuration belongs to.

Example:

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

​
systemConfigId
string
required

The ID of the system configuration to retrieve.

Example:

"87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0"

Response

200
application/json
Successfully retrieved system configuration.

A SystemConfig defines the specific settings for a System Under Test.

Configurations contain parameter values that determine system behavior during evaluation. They are immutable snapshots - once created, they never change.

When running evaluations, you reference a specific configId to establish which configuration to test.

Configurations will be validated against the system's configSchema, with non-conforming values generating warnings.

​
id
string
required

The ID of the system configuration.

​
systemId
string
required

The ID of the system the configuration belongs to.

​
name
string
required

The name of the system configuration.

​
config
object
required

The configuration of the system.

​
validationErrors
object[]

Validation errors found in the configuration. If present, the configuration doesn't fully conform to its system's configSchema.