GET
/
projects
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 project of client.projects.list()) {
  console.log(project.id);
}
{
  "data": [
    {
      "id": "123",
      "name": "Q&A Chatbot",
      "description": "Chatbot for answering questions about the company."
    },
    {
      "id": "124",
      "name": "Summarizer (Europe)",
      "description": "Summarizer for documents in the Europe region."
    }
  ],
  "nextCursor": "125",
  "hasMore": true
}

Authorizations

​
Authorization
string
header
required

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

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:

"123"

Response

200
application/json

Successfully retrieved list of Projects.

The response is of type object.