Upsert system version

Create a new system version if it does not already exist. Does not set the created version to be the system’s production version.

If there is already a system version with the same config, its name will be updated.

POST /systems/{systemId}/versions

JavaScript

JavaScript

import Scorecard from 'scorecard-ai';

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

const systemVersion = await client.systems.versions.upsert('12345678-0a8b-4f66-b6f3-2ddcfa097257', {
  config: {
    temperature: 0.5,
    maxTokens: 1024,
    model: 'gemini-2.0-flash',
  },
  name: 'Test model: Gemini',
});

console.log(systemVersion.id);

200

{
  "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<uuid> · required

The ID of the system to create the system version for.

Example:

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

Body

application/json

config · object · required

The configuration of the system version.

name · string

The name of the system version. If creating a new system version and the name isn't provided, it will be autogenerated.

Response

200

application/json

Successfully upserted system version.

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

System versions 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 systemVersionId to establish which system version to test.

id · string<uuid> · required

The ID of the system version.

systemId · string<uuid> · required

The ID of the system the system version belongs to.

name · string · required

The name of the system version.

config · object · required

The configuration of the system version.