GET
/
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() {
  // Automatically fetches more pages as needed.
  for await (const systemConfig of client.systemConfigs.list('12345678-0a8b-4f66-b6f3-2ddcfa097257')) {
    console.log(systemConfig.id);
  }
}

main();
{
  "data": [
    {
      "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"
      }
    },
    {
      "id": "6fa85f64-5717-4562-b3fc-2c963f66afa8",
      "systemId": "12345678-0a8b-4f66-b6f3-2ddcfa097257",
      "name": "Production (Balanced)",
      "config": {
        "temperature": 0.7,
        "maxTokens": 1024,
        "model": "gpt-4-turbo"
      }
    },
    {
      "id": "7fa85f64-5717-4562-b3fc-2c963f66afa9",
      "systemId": "12345678-0a8b-4f66-b6f3-2ddcfa097257",
      "name": "Experimental (GPT-4 Vision)",
      "config": {
        "temperature": 0.5,
        "maxTokens": 2048,
        "model": "gpt-4-vision",
        "systemPrompt": "You are a helpful visual assistant."
      }
    },
    {
      "id": "8fa85f64-5717-4562-b3fc-2c963f66afa9",
      "systemId": "12345678-0a8b-4f66-b6f3-2ddcfa097257",
      "name": "Invalid Config (Wrong Type)",
      "config": {
        "temperature": "0.5",
        "maxTokens": 2048,
        "model": "gpt-4-turbo"
      },
      "validationErrors": [
        {
          "path": "/config/temperature",
          "message": "Expected number, received string"
        }
      ]
    }
  ],
  "nextCursor": "7fa85f64-5717-4562-b3fc-2c963f66afaa",
  "hasMore": false
}

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 list configurations for.

Example:

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

Query Parameters

​
limit
integer
default:20

Maximum number of items to return (1-100). Use with cursor for pagination through large sets.

Required range: x > 0
Example:

20

​
cursor
string

Cursor for pagination. Pass the nextCursor from the previous response to get the next page of results.

Example:

"eyJvZmZzZXQiOjAsInBhZ2VJZCI6ImNvZGUifQ"

Response

200
application/json

Successfully retrieved list of system configurations.

The response is of type object.