Skip to main content
POST
Cancel a simulation run

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id
string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1
x-organization-id
string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Path Parameters

runId
string<uuid>
required

Simulation run id.

Response

OK

agentId
string<uuid>
required
agentVersionId
string
required
allowWrites
boolean
required

Whether integration writes executed for real.

automationId
string<uuid>
required
createdAt
string<date-time>
required
environmentId
string
required
episodeCount
integer<int64>
required
Required range: -9007199254740991 <= x <= 9007199254740991
failedCount
integer<int64>
required
Required range: -9007199254740991 <= x <= 9007199254740991
passedCount
integer<int64>
required
Required range: -9007199254740991 <= x <= 9007199254740991
runId
string<uuid>
required
scenariosDigest
string
required

SHA-256 of the frozen scenario batch.

status
enum<string>
required

Run lifecycle. Episode verdicts, not run status, say whether the agent passed.

Available options:
pending,
running,
completed,
failed,
cancelled
statusUrl
string
required

Canonical member URL for polling this run.

updatedAt
string<date-time>
required
completedAt
string<date-time>
costMicros
integer

Aggregated cost of the episode and rubric grader sessions in micro-USD, recorded when the run settles. For a cancelled or failed run it is the spend known at settlement, while its sessions were still stopping.

Required range: -9007199254740991 <= x <= 9007199254740991
createdBy
string
error
object

Why the run failed, when it did.

evaluatorAgentId
string<uuid>