Choose a driving evaluation

The driving models SimForge offers for evaluation, caller-owned saved scenarios on accessible maps, and available credit balance. Each of models[] is one offered model version: its id (the modelVersionId a run pins), name, family, whether it can run now (available, with a reason when not: coming soon, or no worker serving it right now) and its own closed-loop price, pricePerScenarioCents (null while it has none; such a model is not available). The top-level pricePerScenarioCents is the standard price. Requires run permission. This grants no map or dataset access.

GET /api/v1/evaluation-options

Choose a driving evaluation

cURL

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

200

{
  "models": [
    {
      "id": "<string>",
      "name": "<string>",
      "family": "<string>",
      "available": true,
      "reason": "<string>",
      "pricePerScenarioCents": 1,
      "loops": {
        "closedLoop": {
          "available": true,
          "reason": "<string>",
          "pricePerScenarioCents": 1
        },
        "openLoop": {
          "available": true,
          "reason": "<string>",
          "pricePerScenarioCents": 1
        }
      },
      "params": [
        {
          "name": "<string>",
          "type": "<string>",
          "default": 123,
          "loops": [
            "<string>"
          ],
          "advanced": true,
          "comparability": "<string>",
          "min": 123,
          "max": 123,
          "step": 123,
          "maxLength": 123,
          "values": [
            "<string>"
          ],
          "loopDefaults": {},
          "fixed": 123,
          "label": "<string>",
          "hint": "<string>"
        }
      ]
    }
  ],
  "admissionsPaused": true,
  "pricePerScenarioCents": 1,
  "balanceCents": 123,
  "billingExempt": true,
  "creditsUrl": "<string>",
  "datasets": [
    {
      "id": "<string>",
      "name": "<string>",
      "scenarioCount": 1,
      "filling": {
        "total": 1
      }
    }
  ],
  "scenarios": [
    {
      "id": "<string>",
      "name": "<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

datasetId · string

Response

200

application/json

Evaluation choices and balance.

models · object[] · required

Show child attributes

admissionsPaused · boolean · required

pricePerScenarioCents · integer · required

Required range: x >= 0

balanceCents · integer · required

billingExempt · boolean · required

creditsUrl · string · required

datasets · object[] · required

Show child attributes

scenarios · object[]

Show child attributes