List runs

GET /api/v1/runs

List runs

cURL

curl --request GET \
  --url https://dev.simforge.ai/api/v1/runs \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "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,
      "jobCount": 1,
      "warningCount": 1,
      "jobs": [
        {
          "id": "<string>",
          "kind": "<string>",
          "status": "queued",
          "errorCode": "<string>",
          "errorReason": "<string>"
        }
      ],
      "idempotencyKey": "<string>",
      "input": "<unknown>",
      "published": true,
      "headline": "<unknown>",
      "unavailable": {
        "code": "<string>",
        "message": "<string>"
      }
    }
  ],
  "nextCursor": "<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.

Query Parameters

cursor · string

Minimum string length: 1

limit · integer · default: 50

Required range: 1 <= x <= 500

status · enum<string>

active: queued or running.

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

type · string

since · string<date-time>

Runs created at or after this ISO 8601 time.

createdBy · enum<string>

me: only the runs the caller submitted in this workspace (no teammate's, none published from other workspaces).

Available options: me

jobs · enum<string>

true: only jobs, leaving out 2D renders (the browser's visualization of the data).

Available options: true

published · enum<string>

true: also the runs SimForge published to every workspace (public benchmarks; createdBy null). Without it the list holds only this workspace's runs. Not with createdBy.

Available options: true

view · enum<string> · default: summary

summary (default): one RunSummary row per run. full: whole Run objects.

Available options: summary, full

Response

200

application/json

Runs, newest first: RunSummary rows, or Run objects with view=full.

Option 1

Option 2

data · object[] · required

Show child attributes

nextCursor · string | null · required