Skip to main content
Rank authored scenario candidates

Authorizations

Authorization
string
header
required

Opaque Firedrill interactive or scoped machine credential. The CLI handles human-approved login; CI stores its scoped credential as FIREDRILL_TOKEN. Capabilities and project/environment ownership are rechecked at use.

Headers

Idempotency-Key
string
required

Save a unique stable key for this exact logical action, at most 200 characters. Reuse it with identical input after an uncertain response. A new key is new intent; it must not be used merely to recover an accepted action.

Required string length: 1 - 200

Body

application/json
projectId
string
required
Required string length: 1 - 160
environmentId
string
required
Required string length: 1 - 160
candidates
object[]
required
Required array length: 1 - 10000 elements
criteria
object[]
required
Required array length: 1 - 12 elements
context
string
Maximum string length: 64000

Response

The retained resource or operation response.

Jev scores remain fractional on a 0–4 scale. A null score/rank is unavailable or unassessable, never zero. Reading a record does not call the provider.

schemaVersion
string
required
Allowed value: "2026-10-18-recommendations.1"
id
string
required
projectId
string
required
environmentId
string
required
state
enum<string>
required
Available options:
completed,
pending,
partial,
unavailable
candidates
object[]
required
reason
null | string
required
provider
null | object
required
createdAt
string
required