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

# Copy a scenario

> Copy a scenario: an independent copy of its current draft (map pin, actors, timeline, settings and render rig) as a fresh draft whose lineage names the original; renders, runs and transfers are not copied. It lands in `datasetId`, else the original's dataset when the caller may write there, else the caller's default dataset (a read-only dataset is never written), named `<name> (copy)` (`(copy 2)`, ... when taken) unless `name` is given. An `Idempotency-Key` header makes it one copy per key: a repeat answers the same copy with 200, and a key already used for another scenario's copy is 409 `idempotency_conflict`. A map version that is no longer its map's latest is 409 `conflict` (`detail.code: scenario_map_version_not_latest`).



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/scenarios/{id}/copy
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/scenarios/{id}/copy:
    post:
      tags:
        - Scenarios
      summary: Copy a scenario
      description: >-
        Copy a scenario: an independent copy of its current draft (map pin,
        actors, timeline, settings and render rig) as a fresh draft whose
        lineage names the original; renders, runs and transfers are not copied.
        It lands in `datasetId`, else the original's dataset when the caller may
        write there, else the caller's default dataset (a read-only dataset is
        never written), named `<name> (copy)` (`(copy 2)`, ... when taken)
        unless `name` is given. An `Idempotency-Key` header makes it one copy
        per key: a repeat answers the same copy with 200, and a key already used
        for another scenario's copy is 409 `idempotency_conflict`. A map version
        that is no longer its map's latest is 409 `conflict` (`detail.code:
        scenario_map_version_not_latest`).
      operationId: copyScenario
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - in: header
          name: Idempotency-Key
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 200
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScenarioCopyRequest'
      responses:
        '200':
          description: The copy an earlier request with this Idempotency-Key made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScenarioCopy'
        '201':
          description: The new copy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScenarioCopy'
        '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'
        '409':
          description: The request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - simforgeToken:
            - scenarios:write
components:
  schemas:
    ScenarioCopyRequest:
      type: object
      properties:
        datasetId:
          type: string
          minLength: 1
        name:
          type: string
          minLength: 1
          maxLength: 200
    ScenarioCopy:
      type: object
      properties:
        id:
          type: string
          minLength: 1
        name:
          type: string
        mapId:
          type:
            - string
            - 'null'
        mapVersionId:
          type:
            - string
            - 'null'
        latestRevisionId:
          type:
            - string
            - 'null'
        updatedAt:
          type: string
          format: date-time
        createdBy:
          type:
            - string
            - 'null'
        tags:
          type: array
          items:
            type: string
        datasetIds:
          type: array
          items:
            type: string
        revisions:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                minLength: 1
              createdAt:
                type: string
                format: date-time
              contentSha256:
                type: string
              mapVersionId:
                type:
                  - string
                  - 'null'
              mapClosureSha256:
                type:
                  - string
                  - 'null'
            required:
              - id
              - createdAt
              - contentSha256
              - mapVersionId
              - mapClosureSha256
        copiedFrom:
          type: object
          properties:
            id:
              type: string
              minLength: 1
            name:
              type: string
          required:
            - id
            - name
        warnings:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
              subject:
                type: string
              detail:
                type: object
                properties: {}
                additionalProperties: {}
            required:
              - code
              - message
      required:
        - id
        - name
        - mapId
        - mapVersionId
        - latestRevisionId
        - updatedAt
        - createdBy
        - tags
        - datasetIds
        - revisions
        - copiedFrom
    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.