Retrieve a run

GET

runs

{run_id}

Retrieve a run

curl --request GET \
  --url https://api.opentype.dev/v1/runs/{run_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.opentype.dev/v1/runs/{run_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "run_id": "<string>",
  "kind": "verdict",
  "state": "pending",
  "input_digest": "<string>",
  "replayed": true,
  "output_digest": "<string>",
  "verdict": "<unknown>",
  "decision": {
    "answers": "<unknown>",
    "draws": 1,
    "read": "slot_constrained",
    "model": "neon-1.1",
    "stages": [
      [
        "<string>"
      ]
    ],
    "thought_tokens": 1,
    "thought_closed": true
  },
  "usage": {
    "input_tokens": 1,
    "output_tokens": 1
  },
  "cost_micros": 1,
  "cost_basis": "provider_reported",
  "schema_enforcement": "unconstrained"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

Authorizations

Authorization

string

header

required

An API key (otsk_ + 64 hex) or a console session token.

Path Parameters

run_id

string

required

run_ followed by 32 hex characters, as the API returns it. The hyphenated form the usage routes return is also accepted.

Response

The run as stored.

A run. A completed run carries verdict or decision, never both. Absent optional fields are omitted, not null. Stored reads (replays, retrieve, stream, list rows) omit cost_basis and schema_enforcement; list rows also omit the answer, usage and cost.

run_id

string

required

run_ followed by 32 hex characters.

kind

enum<string>

required

Which kind of answer this run produces: look at verdict or at decision.

Available options:

verdict,

decision

state

enum<string>

required

Available options:

pending,

running,

completed,

failed

input_digest

string

required

64-character hex SHA-256 of the normalized input, kind and contract.

replayed

boolean

required

true whenever the body came from storage: every replay, retrieve, stream and list row. A replay is never charged again.

output_digest

string | null

verdict

any

Completed verdict runs: your JSON document, validated against your schema.

decision

null | object

The decision's answer set. Present on a completed decision run.

Show child attributes

usage

null | object

Tokens the run used.

Show child attributes

cost_micros

integer<int64> | null

Required range: x >= 0

cost_basis

null | enum<string>

Whether cost_micros was reported by the model service or estimated from the price list. Present exactly when cost_micros is.

Available options:

provider_reported,

estimated

schema_enforcement

null | enum<string>

What constrained the verdict. Present on a fresh verdict run; absent on a replay and on a list row.

Available options:

unconstrained,

requested,

forced,

enforced

Retrieve a run

curl --request GET \
  --url https://api.opentype.dev/v1/runs/{run_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.opentype.dev/v1/runs/{run_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "run_id": "<string>",
  "kind": "verdict",
  "state": "pending",
  "input_digest": "<string>",
  "replayed": true,
  "output_digest": "<string>",
  "verdict": "<unknown>",
  "decision": {
    "answers": "<unknown>",
    "draws": 1,
    "read": "slot_constrained",
    "model": "neon-1.1",
    "stages": [
      [
        "<string>"
      ]
    ],
    "thought_tokens": 1,
    "thought_closed": true
  },
  "usage": {
    "input_tokens": 1,
    "output_tokens": 1
  },
  "cost_micros": 1,
  "cost_basis": "provider_reported",
  "schema_enforcement": "unconstrained"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "violations": [
      "<string>"
    ]
  }
}

Overview

Runs

Model Router

API keys

Usage and quota

Billing

Health

Authorizations

Path Parameters

Response