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

# Exchange a grant for tokens

> The token endpoint (RFC 6749). The public `simforge-cli` client (its `client_id` required): the device code grant, `authorization_code` with PKCE, and rotating `refresh_token`. An AI agent (auth.md, no `client_id`): the claim grant `urn:workos:agent-auth:grant-type:claim`, polling its registration, and the JWT-bearer grant (RFC 7523) re-exchanging the identity assertion the claim grant returned; agents get no refresh token. Unauthenticated by design: each grant is bound by a device code, PKCE, a claim token, an assertion this host signed, or an unspent refresh token. While the person has not approved yet, the device and claim grants answer `authorization_pending` (or `slow_down`).



## OpenAPI

````yaml /api-reference/openapi.json post /api/cli/token
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/cli/token:
    post:
      tags:
        - Sign-in
      summary: Exchange a grant for tokens
      description: >-
        The token endpoint (RFC 6749). The public `simforge-cli` client (its
        `client_id` required): the device code grant, `authorization_code` with
        PKCE, and rotating `refresh_token`. An AI agent (auth.md, no
        `client_id`): the claim grant `urn:workos:agent-auth:grant-type:claim`,
        polling its registration, and the JWT-bearer grant (RFC 7523)
        re-exchanging the identity assertion the claim grant returned; agents
        get no refresh token. Unauthenticated by design: each grant is bound by
        a device code, PKCE, a claim token, an assertion this host signed, or an
        unspent refresh token. While the person has not approved yet, the device
        and claim grants answer `authorization_pending` (or `slow_down`).
      operationId: createCliToken
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CliTokenRequest'
      responses:
        '200':
          description: >-
            A CLI session's access and refresh tokens; an agent's first access
            token and identity assertion (claim grant); or a fresh access token
            (JWT-bearer grant).
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/CliTokenResponse'
                  - $ref: '#/components/schemas/AgentClaimTokenResponse'
                  - $ref: '#/components/schemas/AgentJwtBearerTokenResponse'
        '400':
          description: 'The request failed: an OAuth error object.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CliOAuthError'
        '401':
          description: 'The request failed: an OAuth error object.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CliOAuthError'
        '403':
          description: 'The request failed: an OAuth error object.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CliOAuthError'
        '429':
          description: 'The request failed: an OAuth error object.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CliOAuthError'
      security: []
components:
  schemas:
    CliTokenRequest:
      oneOf:
        - type: object
          properties:
            client_id:
              type: string
              enum:
                - simforge-cli
            grant_type:
              type: string
              enum:
                - urn:ietf:params:oauth:grant-type:device_code
            device_code:
              type: string
          required:
            - client_id
            - grant_type
            - device_code
        - type: object
          properties:
            client_id:
              type: string
              enum:
                - simforge-cli
            grant_type:
              type: string
              enum:
                - authorization_code
            code:
              type: string
            redirect_uri:
              type: string
              description: The loopback redirect the authorization request named.
            code_verifier:
              type: string
              description: The PKCE (S256) verifier.
          required:
            - client_id
            - grant_type
            - code
            - redirect_uri
            - code_verifier
        - type: object
          properties:
            client_id:
              type: string
              enum:
                - simforge-cli
            grant_type:
              type: string
              enum:
                - refresh_token
            refresh_token:
              type: string
              description: >-
                An unspent `sfc_rt_…` token. Refresh tokens rotate: each one is
                spent once.
          required:
            - client_id
            - grant_type
            - refresh_token
        - type: object
          properties:
            grant_type:
              type: string
              enum:
                - urn:workos:agent-auth:grant-type:claim
            claim_token:
              type: string
              description: The `claim_token` of the registration.
          required:
            - grant_type
            - claim_token
        - type: object
          properties:
            grant_type:
              type: string
              enum:
                - urn:ietf:params:oauth:grant-type:jwt-bearer
            assertion:
              type: string
              description: The `identity_assertion` the claim grant returned.
            resource:
              type: string
              description: >-
                Optional (RFC 8707): the protected resource, which must be this
                host's `/api/v1`.
          required:
            - grant_type
            - assertion
    CliTokenResponse:
      type: object
      properties:
        access_token:
          type: string
          description: A `sfc_at_…` bearer token for `/api/v1` and `/api/cli`.
        token_type:
          type: string
          enum:
            - Bearer
        expires_in:
          type: integer
        refresh_token:
          type: string
        refresh_expires_in:
          type: integer
        scope:
          type: string
        session_id:
          type: string
        account:
          type: object
          properties:
            id:
              type: string
            email:
              type: string
            name:
              type: string
          required:
            - id
            - email
            - name
        organization:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            workspace_id:
              type: string
          required:
            - id
            - name
            - workspace_id
      required:
        - access_token
        - token_type
        - expires_in
        - refresh_token
        - refresh_expires_in
        - scope
        - session_id
        - account
        - organization
    AgentClaimTokenResponse:
      type: object
      properties:
        access_token:
          type: string
          description: >-
            A `sfc_at_…` bearer token for `/api/v1`, valid for `expires_in`
            seconds.
        token_type:
          type: string
          enum:
            - Bearer
        expires_in:
          type: integer
        scope:
          type: string
        identity_assertion:
          type: string
          description: >-
            A service-signed JWT: exchange it with the JWT-bearer grant for a
            fresh access token until `assertion_expires`. A secret: keep it like
            a password.
        assertion_expires:
          type: string
        session_id:
          type: string
          description: >-
            The session the account sees and can revoke under Account → CLI
            sessions.
        account:
          type: object
          properties:
            id:
              type: string
            email:
              type: string
            name:
              type: string
          required:
            - id
            - email
            - name
        organization:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            workspace_id:
              type: string
          required:
            - id
            - name
            - workspace_id
      required:
        - access_token
        - token_type
        - expires_in
        - scope
        - identity_assertion
        - assertion_expires
        - session_id
        - account
        - organization
    AgentJwtBearerTokenResponse:
      type: object
      properties:
        access_token:
          type: string
          description: >-
            A `sfc_at_…` bearer token for `/api/v1`, valid for `expires_in`
            seconds.
        token_type:
          type: string
          enum:
            - Bearer
        expires_in:
          type: integer
        scope:
          type: string
      required:
        - access_token
        - token_type
        - expires_in
        - scope
    CliOAuthError:
      type: object
      properties:
        error:
          type: string
          description: >-
            Machine code: an RFC 6749/8628 error (`invalid_grant`,
            `authorization_pending`, `slow_down`, `invalid_token`,
            `insufficient_scope`) or a SimForge code (`not_found`,
            `rate_limited`, …).
        error_description:
          type: string
          description: One sentence for a person.
        detail:
          type: object
          additionalProperties: {}
      required:
        - error
        - error_description

````

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