Skip to main content
GET
Get the cheaper context recipe the outcomes support

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

The namespace name, with any / sent as %2F. Up to 256 bytes. / separates levels of the hierarchy, as in acme/prod/tenant_123.

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 suggestion, or why there is none; status says which.

The cheaper context recipe a version's outcomes support, from its last recipe-tuning run (§6.10), or why there is none.

version
integer<int32>
required
Required range: x >= 1
status
enum<string>
required
  • not_run: no run yet; reason says why.
  • running: a run is testing smaller recipes.
  • ready: suggestion holds a cheaper recipe.
  • none: the last run found none; reason says why.
Available options:
not_run,
running,
ready,
none
reason
enum<string> | null
required

Why there is no suggestion. Not run: awaiting_run (the next calibration run starts it), too_few_outcomes (no calibration fit yet), no_recipe, composite, inherited (the template has the suggestion). None: nothing_to_save (every answer already costs one unit), no_smaller_recipe, no_cheaper_recipe (nothing at least 20% cheaper), accuracy_would_drop, too_few_outcomes, cost_cap (the run stopped at this month's limit) or superseded (the engine's model changed during the run). Null while running and when ready.

Available options:
awaiting_run,
too_few_outcomes,
no_recipe,
composite,
inherited,
nothing_to_save,
no_smaller_recipe,
no_cheaper_recipe,
accuracy_would_drop,
cost_cap,
superseded
message
string
required

What status and reason mean, in a sentence.

headline
string | null
required

One sentence when ready, such as "A context recipe 42% cheaper per answer, with accuracy unchanged within noise on 312 labelled answers."

suggestion
object | null
required

One smaller recipe, measured against the current one on the same labelled answers and engine epoch. Apply it by posting definition as a new version and activating it through its shadow report.

computed_at
string<date-time> | null
required

When the last run ended. Null before one has.

next_run_after
string<date-time> | null
required

The earliest the nightly calibration starts the next run, 30 days after the last started. Null before one has.

plan_required
object | null
required

Set below Team, where the recipe itself is withheld (§9).