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

# Export selected live Tool state as reusable scenario source

> Reads the current lease without changing it. Explicit sensitive-data consent is required. The source omits clock, actors, pending work and history; it is not a runtime snapshot.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/projects/{projectId}/sessions/{sessionId}/scenario-export
openapi: 3.1.0
info:
  title: Firedrill Control API
  version: 1.0.0
  description: >-
    The control plane for drills, drill runs, and the worlds they run in. Errors
    always carry the canonical envelope; unsafe operations require an
    Idempotency-Key; long work returns an operation resource.
servers:
  - url: https://api.firedrill.run
security:
  - controlCredential: []
tags:
  - name: authentication
    description: Sessions, CLI exchange, credentials, and verification keys.
    x-group: Authentication
  - name: organizations
    description: Organization members, billing, usage, retention, audit, and exports.
    x-group: Organizations
  - name: projects
    description: Project lifecycle, access, grants, and repository bindings.
    x-group: Projects
  - name: builds
    description: Immutable builds, uploads, source drafts, and world definitions.
    x-group: Builds and source
  - name: tools
    description: Project Tool discovery, approval, source, and revocation.
    x-group: Tool library
  - name: worlds
    description: >-
      Managed environments, world sessions, state, time, reset, faults, forks,
      and snapshots.
    x-group: Environments and sessions
  - name: runs
    description: >-
      Hosted runs, comparisons, attachments, reports, evidence bundles, sharing,
      and exports.
    x-group: Runs and evidence
  - name: browser
    description: Managed browser tests, runs, messages, streams, frames, and artifacts.
    x-group: Browser testing
  - name: callbacks
    description: Callback receiver approval, revocation, and signing material.
    x-group: Callbacks
  - name: github-ci
    description: >-
      GitHub installations, repository automation, CI suites, cases, evidence,
      and checks.
    x-group: GitHub and CI
  - name: authoring
    description: Authoring sessions, proposals, turns, and scenario proposals.
    x-group: Cloud authoring
paths:
  /v1/projects/{projectId}/sessions/{sessionId}/scenario-export:
    post:
      tags:
        - worlds
      summary: Export selected live Tool state as reusable scenario source
      description: >-
        Reads the current lease without changing it. Explicit sensitive-data
        consent is required. The source omits clock, actors, pending work and
        history; it is not a runtime snapshot.
      operationId: sessions.exportScenario
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
            pattern: ^prj_[0-9a-z]{12,32}$
        - name: sessionId
          in: path
          required: true
          schema:
            type: string
            pattern: ^ses_[0-9a-z]{12,32}$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportSessionScenarioRequest'
      responses:
        '200':
          description: Captured scenario source and provenance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionScenarioExport'
        default:
          description: Canonical error envelope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    ExportSessionScenarioRequest:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 96
          pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
        title:
          type: string
          minLength: 1
          maxLength: 200
        packages:
          minItems: 1
          maxItems: 256
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 96
            pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
        expectedLeaseGeneration:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
        includeSensitiveData:
          type: boolean
          enum:
            - true
          description: >-
            Explicit consent to export raw selected Tool data, which may contain
            sensitive values. Review before sharing. No redaction is performed.
      required:
        - id
        - expectedLeaseGeneration
        - includeSensitiveData
      additionalProperties: false
    SessionScenarioExport:
      type: object
      properties:
        schemaVersion:
          type: number
          enum:
            - 1
        scope:
          type: string
          enum:
            - tool-state
        organizationId:
          type: string
          pattern: ^org_[0-9a-z]{12,32}$
        projectId:
          type: string
          pattern: ^prj_[0-9a-z]{12,32}$
        sessionId:
          type: string
          pattern: ^ses_[0-9a-z]{12,32}$
        worldInstanceId:
          type: string
          pattern: ^world_[A-Za-z0-9][A-Za-z0-9_-]{5,95}$
        buildHash:
          type: string
          pattern: ^sha256:[0-9a-f]{64}$
        packageLockHash:
          type: string
          pattern: ^sha256:[0-9a-f]{64}$
        leaseGeneration:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
        generation:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
          description: >-
            The hosted session lease generation at capture, not a reusable
            source version.
        evidenceSequence:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        sourceHash:
          type: string
          pattern: ^sha256:[0-9a-f]{64}$
        packages:
          minItems: 1
          maxItems: 256
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 96
            pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
        recordCount:
          type: integer
          minimum: 0
          maximum: 50000
        deletionCount:
          type: integer
          minimum: 0
          maximum: 50000
        scenario:
          type: object
          properties:
            schemaVersion:
              type: number
              enum:
                - 1
            id:
              type: string
              minLength: 1
              maxLength: 96
              pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
            title:
              type: string
              minLength: 1
              maxLength: 200
            actors:
              minItems: 0
              maxItems: 0
              type: array
              items:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/SessionScenarioExport___schema0'
            state:
              maxItems: 50000
              type: array
              items:
                oneOf:
                  - type: object
                    properties:
                      action:
                        type: string
                        enum:
                          - upsert
                      packageId:
                        type: string
                        minLength: 1
                        maxLength: 96
                        pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
                      namespace:
                        type: string
                        minLength: 1
                        maxLength: 96
                        pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
                      rowId:
                        type: string
                        minLength: 1
                        maxLength: 512
                      value:
                        type: object
                        additionalProperties:
                          $ref: '#/components/schemas/SessionScenarioExport___schema0'
                    required:
                      - action
                      - packageId
                      - namespace
                      - rowId
                      - value
                    additionalProperties: false
                  - type: object
                    properties:
                      action:
                        type: string
                        enum:
                          - delete
                      packageId:
                        type: string
                        minLength: 1
                        maxLength: 96
                        pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
                      namespace:
                        type: string
                        minLength: 1
                        maxLength: 96
                        pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
                      rowId:
                        type: string
                        minLength: 1
                        maxLength: 512
                    required:
                      - action
                      - packageId
                      - namespace
                      - rowId
                    additionalProperties: false
            faults:
              minItems: 0
              maxItems: 0
              type: array
              items:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/SessionScenarioExport___schema0'
            initialEvents:
              minItems: 0
              maxItems: 0
              type: array
              items:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/SessionScenarioExport___schema0'
          required:
            - schemaVersion
            - id
            - actors
            - state
            - faults
            - initialEvents
          additionalProperties: false
        omitted:
          minItems: 8
          maxItems: 8
          type: array
          items:
            type: string
            enum:
              - actors
              - clock
              - faults
              - pending events
              - callbacks
              - history
              - random position
              - idempotency receipts
        redaction:
          type: string
          enum:
            - none
        runtimeChanged:
          type: boolean
          enum:
            - false
      required:
        - schemaVersion
        - scope
        - organizationId
        - projectId
        - sessionId
        - worldInstanceId
        - buildHash
        - packageLockHash
        - leaseGeneration
        - generation
        - evidenceSequence
        - sourceHash
        - packages
        - recordCount
        - deletionCount
        - scenario
        - omitted
        - redaction
        - runtimeChanged
      additionalProperties: false
    ErrorEnvelope:
      type: object
      properties:
        code:
          type: string
          pattern: ^(control|world)\.[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$
        message:
          type: string
          minLength: 1
        correlationId:
          type: string
          minLength: 1
        retryable:
          type: boolean
        retryAfterMs:
          type: integer
          exclusiveMinimum: 0
          maximum: 9007199254740991
        operationId:
          type: string
        source:
          type: string
          enum:
            - platform
            - simulated_provider
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              code:
                type: string
              message:
                type: string
            required:
              - path
              - code
              - message
            additionalProperties: false
        details:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        evidence:
          type: object
          properties:
            sessionId:
              type: string
            runId:
              type: string
            journalSeq:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            buildHash:
              type: string
          additionalProperties: false
      required:
        - code
        - message
        - correlationId
        - retryable
        - source
      additionalProperties: true
    SessionScenarioExport___schema0:
      description: Any JSON-compatible value
  securitySchemes:
    controlCredential:
      type: http
      scheme: bearer
      description: Opaque control credential

````