> ## Documentation Index
> Fetch the complete documentation index at: https://docs.simforge.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/evaluation-options
openapi: 3.1.0
info:
  title: SimForge Cloud API
  version: '2026-10-24'
  description: >-
    The public SimForge API: what `simforge --cloud`, `simforge login` and the
    Python client call. Authenticate with a bearer token: the access token
    `simforge login` stores, an AI agent's access token (its recipe is
    `/auth.md`), or an `sfk_` API key. A `/api/v1` 401 carries
    `WWW-Authenticate: Bearer
    resource_metadata="<host>/.well-known/oauth-protected-resource"`. `/api/v1`
    errors are an `ErrorEnvelope`; `/api/cli` and `/agent` errors are an OAuth
    error object.


    Versions: send `SimForge-Version: <date>` (2026-10-01, 2026-10-21,
    2026-10-22, 2026-10-23, 2026-10-24) and every `/api/v1` response is in that
    version's shape and names it in the same header; this document describes
    2026-10-24. A request without the header gets 2026-10-01, where an error's
    hint is `detail.hint` and `GET /api/v1/evaluations` names its rows `jobs`. A
    header that is not a date, or a date before 2026-10-01, is `400
    bad_request`. Every response also carries `SimForge-Cli-Minimum`: the oldest
    `simforge` CLI the server serves.


    Retries: from 2026-10-21, send a new `Idempotency-Key` (1-255 characters)
    with every POST, PUT, PATCH and DELETE, and the same key when retrying that
    request. The first request's answer is kept for 24 hours and a repeat gets
    it again with `Idempotent-Replayed: true`; the key with any other request,
    or while the first is still running, is `409 idempotency_conflict`
    (`retryable` while running). A 5xx answer is not kept. Creating an API key
    refuses a key (its secret is shown once).
  license:
    name: Apache-2.0
    identifier: Apache-2.0
servers:
  - url: https://dev.simforge.ai
    description: Development (dev.simforge.ai)
security: []
tags:
  - name: Sign-in
    description: >-
      `simforge login`: OAuth 2.0 device and browser sign-in for the CLI, the
      session behind a token. AI agents sign in through auth.md (`/auth.md`):
      register, a person approves, then the claim and JWT-bearer grants.
  - name: Account
    description: The principal, its workspaces, API keys and usage, and system status.
  - name: Runs
    description: >-
      Cloud runs (`--cloud`): renders, simulations, Recast log ingestion and
      transfers, their events and artifacts.
  - name: Models
    description: Customer fine-tunes and their workspace-owned model weights.
  - name: Datasets
    description: >-
      Datasets, their files as signed links (`simforge.dataset-files/v1`,
      `simforge datasets pull`), and copies out of shared datasets (SIMLOG-25k).
  - name: Maps and vehicles
    description: >-
      Maps the workspace can use, the vehicles a scenario can bind and the asset
      gallery.
  - name: Authoring
    description: >-
      Hosted scenario authoring: drafts, transactions, validation and map
      discovery.
  - name: Distribution
    description: >-
      The runtime and map pack agreement and signed downloads (`simforge runtime
      install`, `simforge maps pull`).
  - name: Telemetry
    description: Runtime usage telemetry, a condition of the runtime terms.
  - name: Benchmark
    description: Renderer benchmark results and scene packs (`simforge bench`).
  - name: Challenge
    description: >-
      The driving challenge: team, registry login and submissions (`simforge
      challenge`).
paths:
  /api/v1/evaluation-options:
    get:
      tags:
        - Runs
      summary: Choose a driving evaluation
      description: >-
        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.
      operationId: getEvaluationChoices
      parameters:
        - in: query
          name: datasetId
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Evaluation choices and balance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluationChoices'
        '400':
          description: The request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: The request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: The request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: The request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - simforgeToken:
            - runs:write
            - datasets:read
            - scenarios:read
            - maps:read
components:
  schemas:
    EvaluationChoices:
      type: object
      properties:
        models:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              family:
                type: string
              available:
                type: boolean
              reason:
                type:
                  - string
                  - 'null'
              pricePerScenarioCents:
                type:
                  - integer
                  - 'null'
                minimum: 0
              loops:
                type: object
                properties:
                  closedLoop:
                    $ref: '#/components/schemas/LoopOffer'
                  openLoop:
                    $ref: '#/components/schemas/LoopOffer'
                required:
                  - closedLoop
                  - openLoop
                description: >-
                  Its offer in each loop; null: not offered in that loop. The
                  top-level available, reason and pricePerScenarioCents are
                  closedLoop's.
              params:
                type: array
                items:
                  $ref: '#/components/schemas/ModelParam'
                description: >-
                  The parameters it takes, each in its `loops`; evaluation
                  requests do not take them yet.
            required:
              - id
              - name
              - family
              - available
              - reason
              - pricePerScenarioCents
        admissionsPaused:
          type: boolean
        pricePerScenarioCents:
          type: integer
          minimum: 0
        balanceCents:
          type: integer
        billingExempt:
          type: boolean
        creditsUrl:
          type: string
        datasets:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              scenarioCount:
                type: integer
                minimum: 0
              filling:
                type:
                  - object
                  - 'null'
                properties:
                  total:
                    type: integer
                    minimum: 0
                required:
                  - total
                description: >-
                  Sample scenarios still being copied in: the dataset will hold
                  `total` scenarios once they are all in; null otherwise.
            required:
              - id
              - name
              - scenarioCount
              - filling
        scenarios:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
            required:
              - id
              - name
      required:
        - models
        - admissionsPaused
        - pricePerScenarioCents
        - balanceCents
        - billingExempt
        - creditsUrl
        - datasets
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - bad_request
                - validation_failed
                - unauthorized
                - insufficient_scope
                - workspace_required
                - not_found
                - conflict
                - gone
                - idempotency_conflict
                - lease_lost
                - budget_exceeded
                - max_cost_required
                - idempotency_key_required
                - insufficient_credits
                - checkout_closed
                - cloud_not_open
                - email_unverified
                - terms_acceptance_required
                - evaluation_launch_disabled
                - evaluation_admissions_paused
                - fine_tunes_not_enabled
                - model_name_reserved
                - model_name_invalid
                - model_name_taken
                - model_quota_exceeded
                - checkpoint_too_large
                - checkpoint_format_unsupported
                - model_family_not_fine_tunable
                - checkpoint_file_unexpected
                - checkpoint_is_offered_model
                - model_version_exists
                - param_unknown
                - param_invalid
                - param_override_not_allowed
                - upload_incomplete
                - upload_mismatch
                - model_in_use
                - rate_limited
                - internal_error
            reason:
              type: string
            hint:
              type: string
            param:
              type: string
            retryable:
              type: boolean
            detail: {}
            path:
              type: string
            requestId:
              type: string
              pattern: ^req_[0-9A-HJKMNP-TV-Z]{26}$
          required:
            - code
            - reason
            - retryable
            - requestId
      required:
        - error
    LoopOffer:
      type:
        - object
        - 'null'
      properties:
        available:
          type: boolean
          description: >-
            Whether an evaluation in this loop can be launched now: offered here
            and served by a worker.
        reason:
          type:
            - string
            - 'null'
          description: >-
            Why not, when it is not available (Coming soon, Temporarily
            unavailable); null when it is.
        pricePerScenarioCents:
          type:
            - integer
            - 'null'
          minimum: 0
          description: One scenario in this loop, in cents; null while it has no price.
      required:
        - available
        - reason
        - pricePerScenarioCents
    ModelParam:
      type: object
      properties:
        name:
          type: string
          description: The parameter's name.
        type:
          type: string
          description: integer, number, string or enum.
        min:
          type: number
        max:
          type: number
        step:
          type: number
        maxLength:
          type: integer
          description: A string's longest length.
        values:
          type: array
          items:
            type: string
          description: An enum's values.
        default:
          anyOf:
            - type: number
            - type: string
            - type: 'null'
          description: >-
            The value used when none is sent; null: none (the model's own
            behaviour).
        loopDefaults:
          type: object
          additionalProperties:
            anyOf:
              - type: number
              - type: string
          description: >-
            The value used in a loop (closedLoop, openLoop) where it differs
            from default.
        fixed:
          anyOf:
            - type: number
            - type: string
          description: 'The one value this model runs with: shown, never changed.'
        loops:
          type: array
          items:
            type: string
          description: 'The loops it applies to: closedLoop, openLoop.'
        advanced:
          type: boolean
          description: Whether a form shows it under Advanced.
        comparability:
          type: string
          description: >-
            standard, or custom: a run with another value than the default is
            compared only with runs of the same values.
        label:
          type: string
        hint:
          type: string
      required:
        - name
        - type
        - default
        - loops
        - advanced
        - comparability
  securitySchemes:
    simforgeToken:
      type: http
      scheme: bearer
      description: >-
        A `sfc_at_…` access token from `simforge login`, or an `sfk_…` API key.
        An operation's security lists the scopes the credential must hold.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.