Runs

Cancel a run

Cancel a queued/running run — stops the provider job (if submitted), refunds the charge, and marks it cancelled. Cancelling a run that is already terminal returns it unchanged.

post/v1/runs/{id}/cancel

Request

  • Base URL: https://api.roroquantum.com
  • URL: https://api.roroquantum.com/v1/runs/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

Response

The cancelled run

idstring
machineTargetIdstring

The target's codename.

machineNamestring

Friendly display name of the target.

shotsinteger
status'queued' | 'running' | 'completed' | 'failed' | 'cancelled'
costnumber double

Credits charged for this run.

countsobject nullable

Measured bitstring counts (present when completed).

probabilitiesobject nullable

Normalized probabilities per bitstring (present when completed).

errorstring nullable

Failure reason (present when status is failed).

createdAtstring date-time
qasmstring nullable

The submitted OpenQASM 2.0 source.

providerJobIdstring nullable

Upstream provider job id

providerStatusstring nullable

Live raw provider status while running (e.g. 'Running'); null for instant simulator runs.

queuePositioninteger nullable

Jobs ahead on the backend while queued; null for instant simulator runs.

refundableboolean

True when a failed, charged run has a machine-side error — you may POST /v1/runs/{id}/refund.

refundStatus'pending' | 'approved' | 'rejected' nullable

The refund audit trail: null (no refund involved), pending (requested), approved (credited — automatic refunds appear here), rejected.

notebookIdstring nullable

Set when the run was submitted from a console notebook.

labProjectIdstring nullable

Set when the run was submitted from a lab project.

countsProvenance'measured' | 'provider-corrected' nullable

Where counts came from: measured as read out, or provider-corrected (the provider already applied its own readout correction). Null for runs that predate the label — read them as received.

effectiveShotsinteger nullable

Shot-equivalents billed — equal to shots for a plain run.

Example response

{
  "id": "8f3a1c2e-…",
  "machineTargetId": "roro.sim.sv",
  "machineName": "RoRo Statevector Simulator",
  "shots": 5000,
  "status": "completed",
  "cost": 25,
  "counts": {
    "11": 2500,
    "00": 2500
  },
  "probabilities": {
    "11": 0.5,
    "00": 0.5
  },
  "createdAt": "2026-06-05T00:00:00Z",
  "effectiveShots": 5000,
  "resilience": {
    "circuits": 5,
    "effectiveShots": 11264
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.