List Library Criteria

Retrieve all criteria in the tenant library

GET /v1/criteria-library

@nova-sdk/api

TypeScript

import { Nova } from "@nova-sdk/api";

const nova = new Nova({
  apiKey: "sk_test_...",
  tenantId: "acme-corp",
});

const library = await nova.criteriaLibrary.list();

200

{
  "criteria": [
    {
      "id": "<string>",
      "text": "<string>",
      "category": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Library criteria are tenant-scoped. Each of your customers has their own isolated library.

When to Use

List library criteria when:

Job Setup UI

Show available library criteria when a user is configuring a new job

Criteria Picker

Let users browse and select criteria to add to a job

Response

Returns all criteria in the tenant’s library, sorted by creation date (newest first).

Each criterion includes:

• id - Unique identifier
• text - The criterion text
• importance - Default importance level
• category - Optional category for grouping
• createdAt - When it was added to the library

Filtering by category

Use the category query parameter to filter results:

GET /v1/criteria-library?category=engineering

Empty Library

If no criteria have been saved to the library yet, the response returns an empty array:

{
  "criteria": []
}

This is a valid response, not an error. Build your library over time by adding criteria that work well.

Authorizations

Authorization · string · header · required

Use Authorization: Bearer sk_test_* or Authorization: Bearer sk_live_*.

Headers

X-Tenant-Id · string · required

Your customer identifier. Tenants are auto-provisioned on first request.

Query Parameters

category · string

Filter by category

Response

200

application/json

Library criteria

criteria · object[] · required

Show child attributes