Cancel a run

POST /api/v1/runs/{id}/cancel

Cancel a run

cURL

curl --request POST \
  --url https://dev.simforge.ai/api/v1/runs/{id}/cancel \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "type": "<string>",
  "status": "queued",
  "createdAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "finishedAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "id": "<string>",
    "email": "<string>"
  },
  "costEstimateCents": 1,
  "costCents": 1,
  "billing": {
    "hold": "pending",
    "heldCents": 1,
    "chargedCents": 1
  },
  "jobs": [
    {
      "id": "<string>",
      "kind": "<string>",
      "status": "queued",
      "attempt": 1,
      "maxAttempts": 123,
      "leaseExpiresAt": "2023-11-07T05:31:56Z",
      "workerClass": "cpu",
      "queue": {
        "blockedBy": [
          "<string>"
        ],
        "ahead": 1,
        "etaSeconds": 1,
        "waitingFor": "worker"
      },
      "errorCode": "<string>",
      "errorReason": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "finishedAt": "2023-11-07T05:31:56Z",
      "progress": "<unknown>"
    }
  ],
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "subject": "<string>",
      "detail": {},
      "jobId": "<string>"
    }
  ],
  "idempotencyKey": "<string>",
  "input": "<unknown>",
  "published": true,
  "result": "<unknown>",
  "unavailable": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Path Parameters

id · string · required

Response

200

application/json

Cancelled run.

id · string · required

type · string · required

status · enum<string> · required

Available options: queued, running, succeeded, partial, failed, cancelled

createdAt · string<date-time> · required

startedAt · string<date-time> | null · required

finishedAt · string<date-time> | null · required

createdBy · object | null · required

Show child attributes

costEstimateCents · integer | null · required

Required range: x >= 0

costCents · integer | null · required

Required range: x >= 0

billing · object · required

Show child attributes

jobs · object[] · required

Show child attributes

warnings · object[] · required

Show child attributes

idempotencyKey · string | null

Caller-supplied run identity; qualification namespaces are excluded from evaluation suites.

input · any

published · boolean

A run published from another workspace (read-only here): a public benchmark. False for a master render of one of your Sample scenarios. Absent means false (a server older than this field).

result · any

unavailable · object

Present when this run's artifacts and result could not be read: result is null and its artifacts are left out, while every other field still holds. The rest of a page is unaffected.

Show child attributes