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

# Run a scenario

> Accepted, not finished: poll the run. `with_agent: true` is a graded run (setup, ticket to the agent, validation, restore) and answers with a report id; `with_agent: false` runs only the phases picked, with no verdict. A disabled scenario is refused.



## OpenAPI

````yaml /0.16/openapi.json post /api/v1/scenarios/{id}/run
openapi: 3.0.3
info:
  title: 2501 Public API
  version: v1
  description: >-
    The stable, versioned HTTP API for driving 2501 as code. See the API
    Overview for authentication, the org_id rule, cursor pagination, and the
    error envelope.
servers:
  - url: https://{command_center_host}
    variables:
      command_center_host:
        default: your-command-center-host
        description: Your Command Center host
security:
  - bearerAuth: []
paths:
  /api/v1/scenarios/{id}/run:
    post:
      tags:
        - Scenarios
      summary: Run a scenario
      description: >-
        Accepted, not finished: poll the run. `with_agent: true` is a graded run
        (setup, ticket to the agent, validation, restore) and answers with a
        report id; `with_agent: false` runs only the phases picked, with no
        verdict. A disabled scenario is refused.
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                phases:
                  type: array
                  items:
                    type: string
                    enum:
                      - prepare
                      - restore
                  minItems: 1
                  default:
                    - prepare
                    - restore
                host:
                  type: string
                  minLength: 1
                with_agent:
                  type: boolean
                  default: false
                gateway:
                  type: string
                  enum:
                    - runner
                    - servicenow
                  default: runner
                main_engine:
                  type: string
                  minLength: 1
                secondary_engine:
                  type: string
                  minLength: 1
                gateway_engine:
                  type: string
                  minLength: 1
      responses:
        '200':
          description: The launched run
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScenarioRunLaunch'
        '400':
          description: >-
            Bad request - a field is missing, malformed, or not allowed
            (VALIDATION_FAILED, BAD_REQUEST, INVALID_CURSOR)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: >-
            No credentials, or a key that is invalid, revoked, or expired
            (UNAUTHORIZED)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Authenticated but not allowed (FORBIDDEN, ORG_ACCESS_DENIED,
            STEP_UP_REFUSED, TWO_FACTOR_ENROLLMENT_REQUIRED,
            LICENSE_CAP_REACHED, LICENSE_EXPIRED)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such row that this caller can see (NOT_FOUND)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            The write conflicts with existing data (CONFLICT, DUPLICATE_KEY,
            FOREIGN_KEY_VIOLATION, RESOURCE_IN_USE)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ScenarioRunLaunch:
      type: object
      properties:
        run_id:
          type: string
          description: >-
            What to poll and stop: the report id of a graded run, the workflow
            id of a phase run
        workflow_id:
          type: string
          example: wfl_7d3b9c2e-...
        phases:
          type: array
          items:
            type: string
            enum:
              - prepare
              - restore
        with_agent:
          type: boolean
        host:
          type: string
        benchmark_id:
          type: string
          example: bch_0f4a6d1b-...
        report_id:
          type: string
          example: scr_ca850e32-...
        report_ids:
          type: array
          items:
            type: string
      required:
        - run_id
        - workflow_id
        - phases
        - with_agent
    Error:
      type: object
      properties:
        code:
          type: string
          example: VALIDATION_FAILED
        message:
          type: string
          example: Validation failed
        request_id:
          type: string
          example: req_3702b7e7-...
        field:
          type: string
          description: Set when one input is at fault
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
            required:
              - field
              - message
          description: Set when several inputs are at fault
        details:
          type: object
          additionalProperties:
            nullable: true
      required:
        - code
        - message
        - request_id
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key minted in Command Center (Settings -> API Keys), sent as
        `Authorization: Bearer 2501_ak_...`. A Command Center session cookie is
        also accepted.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.