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

# Get Voice Clip Set

> Get a voice clip set, including its clips in playback order.



## OpenAPI

````yaml https://api.usetuner.ai/public/openapi.json get /api/v1/workspaces/{workspace_id}/agents/{agent_id}/voice-clip-sets/{voice_clip_set_id}
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}/voice-clip-sets/{voice_clip_set_id}:
    get:
      tags:
        - replay-testing
      summary: Get Voice Clip Set
      description: Get a voice clip set, including its clips in playback order.
      operationId: >-
        get_voice_clip_set_api_v1_workspaces__workspace_id__agents__agent_id__voice_clip_sets__voice_clip_set_id__get
      parameters:
        - name: voice_clip_set_id
          in: path
          required: true
          schema:
            type: integer
            description: ID of the voice clip set
            title: Voice Clip Set Id
          description: ID of the voice clip set
        - 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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceClipSetDetailResponse'
        '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 or voice clip set not found.
          content:
            application/json:
              example:
                detail: Voice clip set with ID 9 not found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - Bearer: []
components:
  schemas:
    VoiceClipSetDetailResponse:
      properties:
        id:
          type: integer
          title: Id
          description: Voice clip set ID.
        name:
          type: string
          title: Name
          description: Name of the voice clip set.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Notes about the voice clip set.
        status:
          type: string
          title: Status
          description: >-
            `extracting` while the caller's clips are being cut, `ready` once
            the set can be replayed, or `failed`.
        clip_count:
          type: integer
          title: Clip Count
          description: Number of clips in the set.
        total_duration_ms:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total Duration Ms
          description: Combined length of all clips in milliseconds. Set once ready.
        caller_track_duration_ms:
          anyOf:
            - type: integer
            - type: 'null'
          title: Caller Track Duration Ms
          description: >-
            Length of the full caller audio track in milliseconds. Set once
            ready.
        source_call_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Source Call Id
          description: ID of the call the set was built from, if it came from a call.
        source_voice_clip_upload_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Source Voice Clip Upload Id
          description: ID of the upload the set was built from, if it came from an upload.
        source_channel_mode:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Channel Mode
          description: Whether the source recording was `mono` or `multi_channel`.
        failure_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Failure Reason
          description: Why extraction failed. Set only when `status` is `failed`.
        transcripts_version:
          type: integer
          title: Transcripts Version
          description: >-
            Goes up whenever any clip's transcript is edited, verified or
            unverified.
          default: 1
        verified_count:
          type: integer
          title: Verified Count
          description: Number of clips whose transcript has been verified.
          default: 0
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the voice clip set was created.
        clips:
          items:
            $ref: '#/components/schemas/VoiceClipResponse'
          type: array
          title: Clips
          description: Clips in playback order.
      type: object
      required:
        - id
        - name
        - status
        - clip_count
        - created_at
      title: VoiceClipSetDetailResponse
      description: Response schema for a single voice clip set including its clips.
    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
    VoiceClipResponse:
      properties:
        id:
          type: integer
          title: Id
          description: Clip ID.
        turn_index:
          type: integer
          title: Turn Index
          description: Position of the clip in the set, in playback order.
        start_ms:
          type: integer
          title: Start Ms
          description: Start of the clip in the caller track, in milliseconds.
        end_ms:
          type: integer
          title: End Ms
          description: End of the clip in the caller track, in milliseconds.
        duration_ms:
          type: integer
          title: Duration Ms
          description: Length of the clip in milliseconds.
        reference_transcript:
          anyOf:
            - type: string
            - type: 'null'
          title: Reference Transcript
          description: Transcript of what the caller said in the clip, if available.
        verified:
          type: boolean
          title: Verified
          description: Whether a person has checked this clip's transcript.
          default: false
        verified_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Verified At
          description: When the transcript was verified. Empty if it is not verified.
        verified_by:
          anyOf:
            - type: integer
            - type: 'null'
          title: Verified By
          description: ID of the user who verified it.
        reference_version:
          type: integer
          title: Reference Version
          description: Goes up each time the transcript is edited.
          default: 1
        draft_source:
          anyOf:
            - type: string
            - type: 'null'
          title: Draft Source
          description: >-
            Which speech-to-text model or voice platform produced the first
            draft.
      type: object
      required:
        - id
        - turn_index
        - start_ms
        - end_ms
        - duration_ms
      title: VoiceClipResponse
      description: A single caller-turn clip within a voice clip set, in playback order.
    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:
    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.