Skip to main content
GET
/
systems
/
{systemId}
JavaScript
import Scorecard from 'scorecard-ai';

const client = new Scorecard({
  apiKey: 'My API Key',
});

const system = await client.systems.get('12345678-0a8b-4f66-b6f3-2ddcfa097257');

console.log(system.id);
{
  "id": "12345678-0a8b-4f66-b6f3-2ddcfa097257",
  "name": "GPT-4 Chatbot",
  "description": "Production chatbot powered by GPT-4",
  "productionVersion": {
    "id": "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0",
    "systemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Version 2 (Low Temperature)",
    "config": {
      "temperature": 0.1,
      "maxTokens": 1024
    }
  },
  "versions": [
    {
      "id": "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0",
      "name": "Version 2 (Low Temperature)"
    },
    {
      "id": "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf1",
      "name": "Version 1 (High Temperature)"
    }
  ]
}

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 retrieve.

Example:

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

Response

Successfully retrieved system.

A System Under Test (SUT).

Systems are templates - to run evaluations, pair them with a SystemVersion that provides specific parameter values.

​
id
string<uuid>
required

The ID of the system.

​
name
string
required

The name of the system. Unique within the project.

​
description
string
default:""
required

The description of the system.

​
productionVersion
object
required

The production version of the system.

​
versions
object[]
required

The versions of the system.