GET
/
projects
/
{projectId}
/
systems
JavaScript
import Scorecard from 'scorecard-ai';

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

// Automatically fetches more pages as needed.
for await (const system of client.systems.list('314')) {
  console.log(system.id);
}
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "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)"
        }
      ]
    },
    {
      "id": "8fb15f74-2918-4982-a4fc-9c157f77dca7",
      "name": "RAG System",
      "description": "Retrieval-augmented generation system for company knowledge base",
      "productionVersion": {
        "id": "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf4",
        "systemId": "8fb15f74-2918-4982-a4fc-9c157f77dca7",
        "name": "Best version",
        "config": {
          "top_k": 2,
          "chunk_size": 512
        }
      },
      "versions": [
        {
          "id": "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf4",
          "name": "Best version"
        }
      ]
    }
  ],
  "nextCursor": "8fb15f74-2918-4982-a4fc-9c157f77dca8",
  "hasMore": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
projectId
string
required

The ID of the system's Project.

Example:

"314"

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

The response is of type object.