> ## 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. # Start a device sign-in > RFC 8628 device authorization (`simforge login --device`). Show `user_code` to the person, who approves it at `verification_uri` in a signed-in browser; then poll the token endpoint every `interval` seconds. ## OpenAPI ````yaml /api-reference/openapi.json post /api/cli/device/code 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="/.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: ` (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/device/code: post: tags: - Sign-in summary: Start a device sign-in description: >- RFC 8628 device authorization (`simforge login --device`). Show `user_code` to the person, who approves it at `verification_uri` in a signed-in browser; then poll the token endpoint every `interval` seconds. operationId: createCliDeviceCode requestBody: required: true content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CliDeviceCodeRequest' responses: '200': description: A device code to poll with and a user code to confirm. content: application/json: schema: $ref: '#/components/schemas/CliDeviceCodeResponse' '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' '429': description: 'The request failed: an OAuth error object.' content: application/json: schema: $ref: '#/components/schemas/CliOAuthError' security: [] components: schemas: CliDeviceCodeRequest: type: object properties: client_id: type: string enum: - simforge-cli device_name: type: string maxLength: 80 description: Shown on the approval page and the account's CLI sessions list. client_version: type: string maxLength: 32 client_platform: type: string maxLength: 40 scope: type: string description: >- Space-separated scopes (default `maps:read`): maps:read, bench:write, scenarios:read, scenarios:write, datasets:read, runs:read, runs:write, artifacts:read, usage:read, models:read, models:write, keys:admin, runtime:read, challenge:write. required: - client_id CliDeviceCodeResponse: type: object properties: device_code: type: string user_code: type: string description: The code the person confirms on the verification page. verification_uri: type: string verification_uri_complete: type: string expires_in: type: integer interval: type: integer description: Seconds between token polls. required: - device_code - user_code - verification_uri - verification_uri_complete - expires_in - interval 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.