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

# Send a feedback ticket

> Send a feedback ticket (a bug, an idea or a question) from the CLI or Studio. Any credential (API key, CLI login, session) or none: an anonymous sender may leave an email. Credentials in the text are redacted before it is stored. At most 10 tickets per account, or 5 per address without a credential, per hour



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/feedback
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/feedback:
    post:
      tags:
        - Account
      summary: Send a feedback ticket
      description: >-
        Send a feedback ticket (a bug, an idea or a question) from the CLI or
        Studio. Any credential (API key, CLI login, session) or none: an
        anonymous sender may leave an email. Credentials in the text are
        redacted before it is stored. At most 10 tickets per account, or 5 per
        address without a credential, per hour
      operationId: sendFeedback
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeedbackInput'
      responses:
        '200':
          description: The stored ticket.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedbackReceipt'
        '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'
        '429':
          description: The request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - {}
        - simforgeToken: []
components:
  schemas:
    FeedbackInput:
      type: object
      properties:
        kind:
          type: string
          enum:
            - bug
            - idea
            - question
        message:
          type: string
          minLength: 1
          maxLength: 4000
        email:
          type: string
          maxLength: 254
          pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
        source:
          type: string
          enum:
            - cli
            - studio
        client:
          type: object
          properties:
            cliVersion:
              type: string
              maxLength: 64
            commit:
              type: string
              maxLength: 64
            os:
              type: string
              maxLength: 32
            arch:
              type: string
              maxLength: 32
            runtimeVersion:
              type: string
              maxLength: 64
            gpu:
              type: string
              maxLength: 200
            agent:
              type: string
              maxLength: 32
          additionalProperties: false
        lastError:
          type: object
          properties:
            command:
              type: string
              maxLength: 128
            flags:
              type: array
              items:
                type: string
                maxLength: 64
              maxItems: 64
            exitCode:
              type: integer
            errorCode:
              type:
                - string
                - 'null'
              maxLength: 128
            reason:
              type:
                - string
                - 'null'
              maxLength: 2000
            httpStatus:
              type:
                - integer
                - 'null'
            requestId:
              type:
                - string
                - 'null'
              maxLength: 128
            map:
              type:
                - string
                - 'null'
              maxLength: 96
            finishedAt:
              type:
                - integer
                - 'null'
            cliVersion:
              type:
                - string
                - 'null'
              maxLength: 64
          required:
            - command
            - flags
            - exitCode
            - errorCode
            - reason
            - httpStatus
            - requestId
            - map
            - finishedAt
            - cliVersion
          additionalProperties: false
        doctor:
          type: object
          properties:
            ok:
              type: boolean
            summary:
              type: object
              properties:
                ok:
                  type: integer
                  minimum: 0
                warn:
                  type: integer
                  minimum: 0
                fail:
                  type: integer
                  minimum: 0
                skipped:
                  type: integer
                  minimum: 0
              required:
                - ok
                - warn
                - fail
                - skipped
              additionalProperties: false
            checks:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    maxLength: 64
                  status:
                    type: string
                    enum:
                      - ok
                      - warn
                      - fail
                      - skipped
                  summary:
                    type: string
                    maxLength: 1000
                  fix:
                    type: string
                    maxLength: 1000
                required:
                  - id
                  - status
                  - summary
                additionalProperties: false
              maxItems: 64
          required:
            - ok
            - summary
            - checks
          additionalProperties: false
        page:
          type: string
          maxLength: 512
      required:
        - kind
        - message
        - source
      additionalProperties: false
    FeedbackReceipt:
      type: object
      properties:
        id:
          type: string
          minLength: 1
        status:
          type: string
          enum:
            - open
            - closed
        createdAt:
          type: string
          format: date-time
      required:
        - id
        - status
        - createdAt
      additionalProperties: false
    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
  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.