Set Criteria

Replace the entire criteria set for a job in one call

PUT /v1/jobs/{jobId}/criteria

@nova-sdk/api

TypeScript

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

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

const current = await nova.jobs.criteria.versions.getCurrent("job_abc123");

const result = await nova.jobs.criteria.set("job_abc123", {
  criteria: [
    { text: "5+ years experience in TypeScript", importance: "MUST_HAVE" },
    { text: "Experience with React", importance: "NICE_TO_HAVE" },
  ],
}, {
  expectedCriteriaRevision: current.criteriaRevision,
});

200

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

Existing scores aren’t affected. A new criteria version is created when you replace criteria. Only future score requests use the updated set.

When to Use

Replace the entire criteria set for a job in a single call. This is useful when:

Bulk Update

You have the complete set of criteria and want to replace everything at once, rather than adding or removing one at a time

External Sync

Your system manages criteria externally and needs to push the latest state to Nova

Stable IDs

Criteria are matched by text. If a criterion with the same text already exists, its id is preserved. This means downstream references (stored IDs, audit logs) remain valid even after a full replacement.

Clearing All Criteria

Pass an empty array to remove all criteria from a job:

{ "criteria": [] }

This behaves like a soft reset. You can add new criteria afterwards via this endpoint, Add Criterion, or Generate Criteria.

If the job is permanently closed, use Archive Criteria instead, which prevents future scoring.

Response

The response includes the full criteria list after the replacement, making it easy to update your UI without a separate GET request.

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.

X-Expected-Criteria-Revision · string

Optional criteria revision precondition for setCriteria. Get the current criteriaRevision from GET /v1/jobs/{jobId}/criteria/versions/current and pass it here to reject stale replacements.

Idempotency-Key · string

Optional key that makes criteria and library mutation requests safe to retry without duplicating side effects. The namespace is shared across all API keys for the same partner and environment. Reuse the same key when retrying the same request parameters.

Required string length: 1 - 255

Path Parameters

jobId · string · required

Your job identifier (external ID).

Body

application/json

criteria · object[] · required

Show child attributes

Response

200

application/json

Criteria replaced

criteria · object[] · required

Show child attributes