Skip to main content
GET
See which alternative your outcomes prefer

Authorizations

Authorization
string
header
required

An organization API key. Keys carry a role (read_write or read_only) and may be restricted to a namespace prefix such as acme/*, or to one namespace such as acme/prod/tenant_1. A prefix matches on a / boundary: acme/prod/tenant_1* covers acme/prod/tenant_1 and everything under acme/prod/tenant_1/, never acme/prod/tenant_12.

Path Parameters

ns
string
required

A namespace name, or a template prefix ending in /*, with any / sent as %2F: acme%2Fprod%2Ftenant_123 or acme%2Fprod%2F*.

A namespace name, or a template prefix: a namespace path ending in /*, such as acme/prod/*, which every namespace under acme/prod/ inherits judgments from. Up to 256 bytes. Never exactly . or .., which a URL path can't carry.

Required string length: 1 - 256
Pattern: ^(?!\.\.?$)[A-Za-z0-9._:/-]+(/\*)?$
name
string
required

A judgment, attribute or threshold name. Names are path segments in field references, so they never contain ..

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

The table, its quote, and its suggestion.

A version's alternatives: which engine, recipe or wording its outcomes prefer, what the labels can and cannot tell, and what scoring costs.

version
integer<int32>
required
Required range: x >= 1
engine_version
string | null
required

The engine epoch of the calibration fit whose labelled answers the alternatives are scored on. Null before a fit.

status
enum<string>
required
  • not_run: nothing scored this month; reason says why.
  • quoting: the quote is being priced; read again shortly.
  • running: this month's run is scoring.
  • ready: suggestion names what the outcomes prefer.
  • none: the run found nothing better beyond noise, or nothing cheaper; message says what was detectable.
Available options:
not_run,
quoting,
running,
ready,
none
reason
enum<string> | null
required

Not run: awaiting_confirm (there is something to score and automatic is off: confirm the quote), awaiting_run (the next calibration run prices it), too_few_outcomes (no calibration fit yet), composite, inherited (the template has the table), budget_paused (the run waits for budget). None: nothing_better (nothing beat the version beyond noise; message says the smallest gain the labels could show), accuracy_would_drop. A narrowing run's own reasons are recipe tuning's. Null when ready, running or quoting.

Available options:
awaiting_confirm,
awaiting_run,
too_few_outcomes,
composite,
inherited,
budget_paused,
nothing_better,
accuracy_would_drop,
superseded
message
string
required

The status in a sentence.

automatic
boolean
required

Whether the run starts by itself after a fit, at most monthly (alternatives.automatic on the judgment). Off by default.

skip_engines
object[]
required

Engines the judgment's setting skips as automatic alternatives.

labels
object
required

The labelled answers the alternatives are scored on.

corrected_for
integer
required

Engine and named alternatives scored this month. Every better and moves_ranking holds after correcting for all of them.

Required range: x >= 0
quote
object | null
required

What scoring the unscored engine and named alternatives would bill, priced before anything runs, and the smallest gain the labels could show. Each answered call is billed as judging: its size class times its engine's weight, at the graduated prices of the tiers your organization is in now.

current
object | null
required

The active version on the same labels, scored the same way. Null before a run.

alternatives
object[]
required

Engine and named alternatives first (in_k: true), then recipe tuning's narrowings.

suggestion
object | null
required

The alternative the outcomes prefer, by id, and why. Nothing is applied.

headline
string | null
required

The suggestion in a sentence, with the correction it holds after.

computed_at
string<date-time> | null
required

RFC 3339, UTC.

next_run_after
string<date-time> | null
required

When the automatic run may next start. Null while automatic is off.

plan_required
object | null
required

Below Team, why scoring engine and named alternatives, and the narrowings' recipes, are withheld.