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

# List Replay Runs

> List an agent's replay runs with their replayed test calls.

Each run includes its simulation calls, pass/fail counts, and the clip sets and
evals it was configured with. Filter by `status` to poll for completion.



## OpenAPI

````yaml https://api.usetuner.ai/public/openapi.json get /api/v1/workspaces/{workspace_id}/agents/{agent_id}/replay-runs
openapi: 3.1.0
info:
  title: Tuner API
  description: >-
    Send calls to Tuner and manage agents, evaluation settings, simulations and
    workspace settings.
  version: 1.0.0
servers:
  - url: https://api.usetuner.ai
security: []
tags:
  - name: calls
    description: Send call recordings and transcripts to Tuner and retrieve call details.
    x-group: Calls
  - name: workspaces
    description: >-
      Manage your workspaces, the API keys used to access them, and their PII
      redaction and data retention settings.
    x-group: Workspaces
  - name: simulation
    description: >-
      Run simulated calls against your agents, manage simulation profiles, and
      look up the caller personas and background-noise environments they can
      use.
    x-group: Simulation
  - name: scenarios
    description: Manage the test scenarios that simulated calls follow.
    x-group: Scenarios
  - name: replay-testing
    description: >-
      Replay recorded caller audio against a new version of your agent: upload
      or extract voice clips from real calls, then run them as replay runs.
    x-group: Replay Testing
  - name: agents
    description: Create, update and list the voice agents connected to your workspace.
    x-group: Agents
  - name: agent-settings
    description: >-
      Configure how Tuner evaluates an agent's calls, including evaluations,
      call outcomes, intents, data extraction, rules and alerts, plus the
      agent's SIP and outbound call configuration.
    x-group: Agent Settings
  - name: traces
    description: Send OpenTelemetry traces from your agent to Tuner.
    x-group: Traces
  - name: providers
    description: List the voice providers Tuner can connect to.
    x-group: Providers
paths:
  /api/v1/workspaces/{workspace_id}/agents/{agent_id}/replay-runs:
    get:
      tags:
        - replay-testing
      summary: List Replay Runs
      description: >-
        List an agent's replay runs with their replayed test calls.


        Each run includes its simulation calls, pass/fail counts, and the clip
        sets and

        evals it was configured with. Filter by `status` to poll for completion.
      operationId: >-
        list_replay_runs_api_v1_workspaces__workspace_id__agents__agent_id__replay_runs_get
      parameters:
        - name: agent_id
          in: path
          required: true
          schema:
            type: integer
            description: Tuner's internal numeric ID for the agent.
            title: Agent Id
          description: Tuner's internal numeric ID for the agent.
        - name: workspace_id
          in: path
          required: true
          schema:
            type: integer
            description: Workspace ID. Find this in Workspace > General Settings.
            title: Workspace Id
          description: Workspace ID. Find this in Workspace > General Settings.
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - enum:
                  - pending
                  - running
                  - analyzing
                  - complete
                  - partial
                  - failed
                  - unreported
                  - analysis_failed
                type: string
              - type: 'null'
            description: Only return runs with this status.
            title: Status
          description: Only return runs with this status.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number, starting at 1.
            default: 1
            title: Page
          description: Page number, starting at 1.
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Number of runs per page (1-100).
            default: 20
            title: Page Size
          description: Number of runs per page (1-100).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplayRunsDetailResponse'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              example:
                detail: Not authenticated
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: You do not have access to this workspace.
          content:
            application/json:
              example:
                detail: User does not have access to workspace 42
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Agent not found.
          content:
            application/json:
              example:
                detail: Agent with ID 17 not found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - Bearer: []
components:
  schemas:
    ReplayRunsDetailResponse:
      properties:
        replay_runs:
          items:
            $ref: '#/components/schemas/ReplayRunDetailItem'
          type: array
          title: Replay Runs
          description: Runs on this page, newest first.
        total:
          type: integer
          title: Total
          description: Total number of runs matching the request, across all pages.
        page:
          type: integer
          title: Page
          description: Current page number, starting at 1.
        page_size:
          type: integer
          title: Page Size
          description: Maximum number of runs per page.
        total_pages:
          type: integer
          title: Total Pages
          description: Total number of pages.
      type: object
      required:
        - replay_runs
        - total
        - page
        - page_size
        - total_pages
      title: ReplayRunsDetailResponse
      description: A page of replay runs with their replayed calls and results.
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Human-readable description of what went wrong.
      type: object
      required:
        - detail
      title: ErrorResponse
      description: Error body returned when a request fails.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ReplayRunDetailItem:
      properties:
        id:
          type: integer
          title: Id
          description: ID of the replay run.
        status:
          type: string
          title: Status
          description: >-
            Run status: `pending`, `running`, `analyzing`, `complete`,
            `partial`, `failed`, `unreported` or `analysis_failed`. `complete`
            means every call finished and was analyzed. `running` means calls
            are still executing, or have finished but none has been received
            yet. `analyzing` means calls have finished executing and some are
            still being reported or evaluated. `failed`, `unreported` and
            `analysis_failed` mean no call was analyzed, because every call
            failed, no call report arrived, or analysis failed, respectively.
            `failed` is also used when scenario generation fails; see
            `failure_reason`. `partial` is a mix of these.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the run was created.
        execution_completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Execution Completed At
          description: >-
            When every call finished executing. Null while calls are still in
            progress. The run can remain `running` or `analyzing` after this
            while calls are reported and evaluated.
        failure_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Failure Reason
          description: Explanation of why the run failed. Null if it did not fail.
        generated_count:
          type: integer
          title: Generated Count
          description: Number of test scenarios created so far.
        voice_clip_sets:
          items:
            $ref: '#/components/schemas/VoiceClipSetRef'
          type: array
          title: Voice Clip Sets
          description: Voice clip sets played by the run.
        replay_repeat_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Replay Repeat Count
          description: Number of times each clip set was replayed.
        replay_settings:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Replay Settings
          description: Turn-timing overrides the replay used.
        evals_expected:
          type: boolean
          title: Evals Expected
          description: >-
            Whether the calls are graded by evals. False only for replay runs
            started without evals.
          default: true
        selected_evals:
          items:
            $ref: '#/components/schemas/CriteriaItem'
          type: array
          title: Selected Evals
          description: The evals the calls are graded with. Empty if none were selected.
        passed_count:
          type: integer
          title: Passed Count
          description: Number of calls that passed their evals.
        failed_count:
          type: integer
          title: Failed Count
          description: Number of calls that failed their evals.
        in_progress_count:
          type: integer
          title: In Progress Count
          description: >-
            Number of calls still waiting for results (not yet finished or
            evaluated).
        ran_count:
          type: integer
          title: Ran Count
          description: >-
            Number of calls that completed in a run started without evals, so
            there was nothing to grade them.
          default: 0
        unreported_count:
          type: integer
          title: Unreported Count
          description: Number of calls that completed but whose call data never arrived.
          default: 0
        analysis_failed_count:
          type: integer
          title: Analysis Failed Count
          description: Number of calls that arrived but whose evals never came back.
          default: 0
        simulation_calls:
          items:
            $ref: '#/components/schemas/SimulationCallDetailResponse'
          type: array
          title: Simulation Calls
          description: The replayed calls in the run, one per clip set and repetition.
      type: object
      required:
        - id
        - status
        - created_at
        - failure_reason
        - generated_count
        - selected_evals
        - passed_count
        - failed_count
        - in_progress_count
        - simulation_calls
      title: ReplayRunDetailItem
      description: A replay run with its replayed calls, eval results and pass/fail counts.
    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
    VoiceClipSetRef:
      properties:
        id:
          type: integer
          title: Id
          description: ID of the voice clip set.
        name:
          type: string
          title: Name
          description: Name of the voice clip set when the run started.
      type: object
      required:
        - id
        - name
      title: VoiceClipSetRef
      description: A voice clip set played by a replay run, as it was when the run started.
    CriteriaItem:
      properties:
        id:
          type: integer
          title: Id
          description: ID of the eval or intent.
        name:
          type: string
          title: Name
          description: Name of the eval or intent.
      type: object
      required:
        - id
        - name
      title: CriteriaItem
      description: An eval or call intent a run was configured with.
    SimulationCallDetailResponse:
      properties:
        id:
          type: integer
          title: Id
          description: >-
            ID of the simulated call. Falls back to the scenario ID if the call
            has not been placed yet.
        scenario_id:
          type: integer
          title: Scenario Id
          description: ID of the scenario the call was placed for.
        type:
          type: string
          title: Type
          description: >-
            Scenario type, such as `functional`, `adversarial` or
            `recorded_clips`.
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
          description: >-
            Status of the simulated call: `initiated`, `in_progress`,
            `completed` or `failed`. Null if the call has not been placed yet.
        duration:
          anyOf:
            - type: number
            - type: 'null'
          title: Duration
          description: Duration of the simulated call, in minutes. Null if not available.
        outcome:
          anyOf:
            - $ref: '#/components/schemas/OutcomeDetail'
            - type: 'null'
          description: Call outcome detected on the call. Null if none was detected.
        intent:
          anyOf:
            - type: string
            - type: 'null'
          title: Intent
          description: Call intent detected on the call. Null if none was detected.
        evals:
          items:
            $ref: '#/components/schemas/SimulationCallEvalResult'
          type: array
          title: Evals
          description: Eval results for the call. Empty until evals have been reported.
        call_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Call Id
          description: >-
            ID of the resulting call, once it has reached Tuner. Null until
            then.
        analysis_stopped:
          type: boolean
          title: Analysis Stopped
          description: Whether the call outcome is one that stops further analysis.
          default: false
        unreported:
          type: boolean
          title: Unreported
          description: Whether the call completed but no call data ever arrived.
          default: false
        analysis_failed:
          type: boolean
          title: Analysis Failed
          description: Whether the call arrived but its evals never came back.
          default: false
        failure:
          anyOf:
            - $ref: '#/components/schemas/SimulationCallFailure'
            - type: 'null'
          description: >-
            Why the call, or its scenario before any call was placed, failed.
            Null unless it failed.
        target_eval_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Target Eval Label
          description: Name of the eval or call outcome the scenario targeted in this call.
        target_ai_evaluation:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Target Ai Evaluation
          description: The eval or call outcome the scenario targets. Null if it has none.
        clip_set_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Clip Set Name
          description: Name of the voice clip set played. Null for non-replay runs.
        repetition:
          anyOf:
            - type: integer
            - type: 'null'
          title: Repetition
          description: >-
            1-based repetition of the clip set that this call replayed. Null for
            non-replay runs.
        saved_scenario_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Saved Scenario Id
          description: >-
            ID of the library scenario this call's scenario was saved as. Null
            if it has not been saved to the library.
        persona:
          anyOf:
            - type: string
            - type: 'null'
          title: Persona
          description: >-
            Label of the scenario: the generated persona, or the library
            scenario's name for runs from saved scenarios. Null if not
            available, and for replay runs.
      type: object
      required:
        - id
        - scenario_id
        - type
        - status
        - duration
        - outcome
        - intent
        - evals
        - call_id
      title: SimulationCallDetailResponse
      description: A simulated call within a run, with its status and results.
    OutcomeDetail:
      properties:
        value:
          anyOf:
            - type: string
            - type: 'null'
          title: Value
          description: Name of the detected call outcome.
        type:
          anyOf:
            - type: string
            - type: 'null'
          title: Type
          description: Type of the detected call outcome.
      type: object
      required:
        - value
        - type
      title: OutcomeDetail
      description: The outcome detected on a simulated call.
    SimulationCallEvalResult:
      properties:
        label:
          type: string
          title: Label
          description: Name of the eval.
        value:
          anyOf:
            - type: string
            - type: 'null'
          title: Value
          description: Result of the eval. Null if it produced no value.
        evidence:
          anyOf:
            - type: string
            - type: 'null'
          title: Evidence
          description: Explanation of the result. Null if none was given.
      type: object
      required:
        - label
        - value
        - evidence
      title: SimulationCallEvalResult
      description: The result of one eval on a simulated call.
    SimulationCallFailure:
      properties:
        reason:
          type: string
          title: Reason
        title:
          type: string
          title: Title
        message:
          type: string
          title: Message
      type: object
      required:
        - reason
        - title
        - message
      title: SimulationCallFailure
      description: Why a simulation call failed, in words safe to show a customer.
  securitySchemes:
    Bearer:
      type: http
      description: >-
        Use Tuner API key (tr_api_...) or user session token. Find your API key
        in Workspace Settings > API Keys.
      scheme: bearer

````

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