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

# Start a reviewed simulation plan

> Admits the retained cases to the durable coordinator without requiring a repository or GitHub connection. Cases receive isolated Tool state as capacity permits; the customer's authenticated runner executes their agent. The immutable receipt acknowledges launch, not agent execution or passing checks. An identical request/key returns the original receipt with current progress.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/projects/{projectId}/simulations
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: []
paths:
  /v1/projects/{projectId}/simulations:
    post:
      summary: Start a reviewed simulation plan
      description: >-
        Admits the retained cases to the durable coordinator without requiring a
        repository or GitHub connection. Cases receive isolated Tool state as
        capacity permits; the customer's authenticated runner executes their
        agent. The immutable receipt acknowledges launch, not agent execution or
        passing checks. An identical request/key returns the original receipt
        with current progress.
      operationId: simulations.start
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
            pattern: ^prj_[0-9a-z]{12,32}$
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 8
            maxLength: 128
            pattern: ^[A-Za-z0-9._:-]+$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartSimulationRequest'
      responses:
        '200':
          description: Original launch replay and current progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationLaunchResponse'
        '202':
          description: Original launch receipt and current progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationLaunchResponse'
        default:
          description: Canonical error envelope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    StartSimulationRequest:
      type: object
      properties:
        planId:
          type: string
          pattern: ^simplan_[0-9a-z]{12,32}$
        planDigest:
          type: string
          pattern: ^sha256:[0-9a-f]{64}$
      required:
        - planId
        - planDigest
      additionalProperties: false
    SimulationLaunchResponse:
      type: object
      properties:
        receipt:
          type: object
          properties:
            schemaVersion:
              type: number
              enum:
                - 1
            batchId:
              type: string
              pattern: ^cisuite_[0-9a-z]{12,32}$
            planId:
              type: string
              pattern: ^simplan_[0-9a-z]{12,32}$
            planDigest:
              type: string
              pattern: ^sha256:[0-9a-f]{64}$
            acceptedAtMs:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
            - schemaVersion
            - batchId
            - planId
            - planDigest
            - acceptedAtMs
          additionalProperties: false
        batch:
          type: object
          properties:
            schemaVersion:
              type: number
              enum:
                - 1
            batchId:
              type: string
              pattern: ^cisuite_[0-9a-z]{12,32}$
            projectId:
              type: string
              pattern: ^prj_[0-9a-z]{12,32}$
            environmentId:
              type: string
              pattern: ^env_[0-9a-z]{12,32}$
            planId:
              type: string
              pattern: ^simplan_[0-9a-z]{12,32}$
            planDigest:
              type: string
              pattern: ^sha256:[0-9a-f]{64}$
            buildHash:
              type: string
              pattern: ^sha256:[0-9a-f]{64}$
            state:
              type: string
              enum:
                - preparing
                - running
                - cancelling
                - completed
                - failed
                - cancelled
            counts:
              type: object
              properties:
                logicalCases:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                attemptCases:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                pending:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                active:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                passed:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                failed:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                inconclusive:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                error:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                cancelled:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
              required:
                - logicalCases
                - attemptCases
                - pending
                - active
                - passed
                - failed
                - inconclusive
                - error
                - cancelled
              additionalProperties: false
            version:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            createdAtMs:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            updatedAtMs:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            finishedAtMs:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            conclusion:
              type: string
              enum:
                - passed
                - failed
                - inconclusive
                - error
                - cancelled
            result:
              type: object
              properties:
                schemaVersion:
                  type: number
                  enum:
                    - 1
                kind:
                  type: string
                  enum:
                    - simulation
                conclusion:
                  type: string
                  enum:
                    - passed
                    - failed
                    - inconclusive
                    - error
                    - cancelled
                durationMs:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                counts:
                  type: object
                  properties:
                    logicalCases:
                      type: integer
                      minimum: 0
                      maximum: 10000
                    passed:
                      type: integer
                      minimum: 0
                      maximum: 10000
                    failed:
                      type: integer
                      minimum: 0
                      maximum: 10000
                    inconclusive:
                      type: integer
                      minimum: 0
                      maximum: 10000
                    error:
                      type: integer
                      minimum: 0
                      maximum: 10000
                    cancelled:
                      type: integer
                      minimum: 0
                      maximum: 10000
                  required:
                    - logicalCases
                    - passed
                    - failed
                    - inconclusive
                    - error
                    - cancelled
                  additionalProperties: false
                attemptCases:
                  type: integer
                  minimum: 0
                  maximum: 110000
                batchId:
                  type: string
                  pattern: ^cisuite_[0-9a-z]{12,32}$
              required:
                - schemaVersion
                - kind
                - conclusion
                - durationMs
                - counts
                - attemptCases
                - batchId
              additionalProperties: false
            failure:
              type: object
              properties:
                schemaVersion:
                  type: number
                  enum:
                    - 1
                code:
                  type: string
                  pattern: ^[a-z][a-z0-9-]*\.[A-Z][A-Z0-9_]*$
                source:
                  type: string
                  enum:
                    - framework
                    - world
                    - tool
                    - target
                    - assertion
                    - reporter
                    - control
                message:
                  type: string
                  minLength: 1
                  maxLength: 4000
                retryable:
                  type: boolean
                correlationId:
                  type: string
                  pattern: ^corr_[A-Za-z0-9][A-Za-z0-9_-]{5,95}$
                issues:
                  default: []
                  type: array
                  items:
                    type: object
                    properties:
                      code:
                        type: string
                        minLength: 1
                        maxLength: 128
                      message:
                        type: string
                        minLength: 1
                        maxLength: 2000
                      path:
                        type: array
                        items:
                          anyOf:
                            - type: string
                            - type: integer
                              minimum: 0
                              maximum: 9007199254740991
                      suggestion:
                        type: string
                        minLength: 1
                        maxLength: 4000
                    required:
                      - code
                      - message
                    additionalProperties: {}
                details:
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/SimulationLaunchResponse___schema0'
                evidence:
                  type: object
                  properties:
                    runId:
                      type: string
                      pattern: ^run_[A-Za-z0-9][A-Za-z0-9_-]{5,95}$
                    sequence:
                      type: integer
                      minimum: 0
                      exclusiveMinimum: true
                      maximum: 9007199254740991
                  additionalProperties: {}
              required:
                - schemaVersion
                - code
                - source
                - message
                - retryable
                - issues
              additionalProperties: {}
            resultsUrl:
              type: string
              maxLength: 2048
              format: uri
          required:
            - schemaVersion
            - batchId
            - projectId
            - environmentId
            - planId
            - planDigest
            - buildHash
            - state
            - counts
            - version
            - createdAtMs
            - updatedAtMs
            - resultsUrl
          additionalProperties: false
        replayed:
          type: boolean
      required:
        - receipt
        - batch
        - replayed
      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
    SimulationLaunchResponse___schema0:
      description: Any JSON-compatible value
  securitySchemes:
    controlCredential:
      type: http
      scheme: bearer
      description: Opaque control credential

````