POST
/
systems
/
{systemId}
/
configs
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 systemConfig = await client.systemConfigs.create('12345678-0a8b-4f66-b6f3-2ddcfa097257', {
    config: { temperature: 0.1, maxTokens: 1024, model: 'gpt-4-turbo' },
    name: 'Production (Low Temperature)',
  });

  console.log(systemConfig.id);
}

main();
{
  "id": "5fa85f64-5717-4562-b3fc-2c963f66afa7",
  "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 to create the configuration for.

Example:

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

Body

application/json

Response

201
application/json

System configuration created successfully

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.