Skip to main content
GET
Get a run

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer <key>. Each operation lists the scope its key needs: decisions:evaluate (evaluate and read evaluations), decisions:feedback (your app's feedback) or decisions:develop (everything else, including owner feedback and the review queue). An operation listing no scope takes any scoped key. A key with no scope, or without the operation's, gets 403 INSUFFICIENT_SCOPE.

Scopes

decisions:evaluate
decisions:develop

Path Parameters

run_id
string
required
Pattern: ^evr_[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response

The run as its create call answered it: a Run from createRun, or an ImportExamplesResponse from import_examples

run_id
string
required

Pass it to loss_report, or read this response back with getRun; kept until expires_at. A stored run's evaluations stay after it expires.

Pattern: ^evr_[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
expires_at
string<date-time>
required
dry_run
boolean
required

Whether the items were dry runs (no evaluation stored; the run keeps their results) or stored as evaluations.

environment
enum<string>
required

The environment of the key that made the call: production or test. Evaluations, feedback, reviews and suggestions are separate per environment; decisions and their versions belong to the whole organization.

Available options:
production,
test
decision_id
string
required

A name you choose for this decision, such as refund-exception: a lowercase letter, then up to 127 of a-z 0-9 _ . -. Unique in your organization and shared by its test and production keys. The first registration or evaluation under a new one creates the decision.

Pattern: ^[a-z][a-z0-9_.-]{0,127}$
version
object
required

The version that ran.

model
object
required

The model that answered.

counts
object
required
cost
object
required
results
object[]
required

One per item results lists (every item by default; with failed only the failed ones, with none none), in item order (cases: newest label first).

cases
object

With cases: which cases the run took.