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

# Dispatch a simulation run



## OpenAPI

````yaml /api-reference/openapi.json post /v1/simulation/runs
openapi: 3.1.0
info:
  title: Feather API
  description: >-
    Unified customer experience platform API. Manages identity, conversations,
    memory, agents, procedures, policies, model routing, knowledge bases,
    integrations, and runtime execution.
  version: 1.21.0
servers:
  - url: https://api-sandbox.featherhq.com
    description: Sandbox
  - url: http://localhost:8000
    description: Local dev
security: []
paths:
  /v1/simulation/runs:
    post:
      tags:
        - simulation_runs
      summary: Dispatch a simulation run
      operationId: dispatchSimulationRun
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulationRunDispatch'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationRunResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    SimulationRunDispatch:
      properties:
        agent_id:
          type: string
          format: uuid
          title: Agent Id
        agent_revision_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Agent Revision Id
        persona_id:
          type: string
          format: uuid
          title: Persona Id
        scenario_id:
          type: string
          format: uuid
          title: Scenario Id
        channel:
          $ref: '#/components/schemas/ScenarioChannel'
          default: voice
        tool_overrides:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/CannedToolResponse'
              type: object
            - type: 'null'
          title: Tool Overrides
      type: object
      required:
        - agent_id
        - persona_id
        - scenario_id
      title: SimulationRunDispatch
      description: |-
        Request body for ``POST /v1/simulation/runs``.

        Unlike :class:`SimulationRunCreate` (which describes a row that already
        has a ``Conversation``), this is the public orchestrator payload:
        the service creates the session row and the run row in one transaction
        and then dispatches the Celery worker.
    SimulationRunResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        session_id:
          type: string
          format: uuid
          title: Session Id
        organization_id:
          type: string
          format: uuid
          title: Organization Id
        agent_id:
          type: string
          format: uuid
          title: Agent Id
        agent_revision_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Agent Revision Id
        persona_id:
          type: string
          format: uuid
          title: Persona Id
        scenario_id:
          type: string
          format: uuid
          title: Scenario Id
        channel:
          $ref: '#/components/schemas/ScenarioChannel'
        tool_overrides:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Tool Overrides
        status:
          type: string
          title: Status
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
        finished_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finished At
        error_text:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Text
        inputs_snapshot:
          additionalProperties: true
          type: object
          title: Inputs Snapshot
        created_at:
          type: string
          format: date-time
          title: Created At
        recording_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Recording Id
        recording_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Recording Status
      type: object
      required:
        - id
        - session_id
        - organization_id
        - agent_id
        - agent_revision_id
        - persona_id
        - scenario_id
        - channel
        - tool_overrides
        - status
        - started_at
        - finished_at
        - error_text
        - inputs_snapshot
        - created_at
      title: SimulationRunResponse
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
        message:
          type: string
          title: Message
      type: object
      required:
        - error
        - message
      title: ErrorResponse
      description: Standard error response returned by all API error handlers.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ScenarioChannel:
      type: string
      enum:
        - text
        - voice
      title: ScenarioChannel
    CannedToolResponse:
      properties:
        output:
          title: Output
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        delay_ms:
          type: integer
          maximum: 60000
          minimum: 0
          title: Delay Ms
          default: 0
      additionalProperties: false
      type: object
      title: CannedToolResponse
      description: >-
        One canned response in tool_overrides — Option A grammar.


        Exactly one of ``output`` / ``error`` must be set (ENG-133): a canned
        success carries

        ``output`` (an explicit ``output: null`` is a valid null result), a
        canned failure carries a

        non-empty ``error``. Set-ness is read from ``model_fields_set`` so an
        explicit ``output: null``

        is distinguished from an absent field; ``delay_ms`` simulates latency
        before the response.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````