Retrieve a run
Reads one run from stored state. Requires runs_read. Never calls the model, so reading a run is free.
A completed run carries its verdict or decision, plus usage and cost_micros. Stored reads omit cost_basis and schema_enforcement, and a stored decision omits model, stages and the thought fields. A run that is not completed returns the run without an answer.
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));import requests
url = "https://api.opentype.dev/v1/runs/{run_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"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
An API key (otsk_ + 64 hex) or a console session token.
Path Parameters
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_ followed by 32 hex characters.
Which kind of answer this run produces: look at verdict or at decision.
verdict, decision pending, running, completed, failed 64-character hex SHA-256 of the normalized input, kind and contract.
true whenever the body came from storage: every replay, retrieve, stream and list row. A replay is never charged again.
Completed verdict runs: your JSON document, validated against your schema.
The decision's answer set. Present on a completed decision run.
Show child attributes
Show child attributes
Tokens the run used.
Show child attributes
Show child attributes
x >= 0Whether cost_micros was reported by the model service or estimated from the price list. Present exactly when cost_micros is.
provider_reported, estimated What constrained the verdict. Present on a fresh verdict run; absent on a replay and on a list row.
unconstrained, requested, forced, enforced 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));import requests
url = "https://api.opentype.dev/v1/runs/{run_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"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>"
]
}
}