Skip to main content
GET
Get Voice Clip Set

Authorizations

Authorization
string
header
required

Use Tuner API key (tr_api_...) or user session token. Find your API key in Workspace Settings > API Keys.

Path Parameters

voice_clip_set_id
integer
required

ID of the voice clip set

agent_id
integer
required

Tuner's internal numeric ID for the agent.

workspace_id
integer
required

Workspace ID. Find this in Workspace > General Settings.

Response

Successful Response

Response schema for a single voice clip set including its clips.

id
integer
required

Voice clip set ID.

name
string
required

Name of the voice clip set.

status
string
required

extracting while the caller's clips are being cut, ready once the set can be replayed, or failed.

clip_count
integer
required

Number of clips in the set.

created_at
string<date-time>
required

When the voice clip set was created.

description
string | null

Notes about the voice clip set.

total_duration_ms
integer | null

Combined length of all clips in milliseconds. Set once ready.

caller_track_duration_ms
integer | null

Length of the full caller audio track in milliseconds. Set once ready.

source_call_id
integer | null

ID of the call the set was built from, if it came from a call.

source_voice_clip_upload_id
integer | null

ID of the upload the set was built from, if it came from an upload.

source_channel_mode
string | null

Whether the source recording was mono or multi_channel.

failure_reason
string | null

Why extraction failed. Set only when status is failed.

transcripts_version
integer
default:1

Goes up whenever any clip's transcript is edited, verified or unverified.

verified_count
integer
default:0

Number of clips whose transcript has been verified.

clips
VoiceClipResponse · object[]

Clips in playback order.