Skip to main content
POST
Create 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

agent_id
integer
required

Tuner's internal numeric ID for the agent.

workspace_id
integer
required

Workspace ID. Find this in Workspace > General Settings.

Body

application/json

Input schema for creating a voice clip set.

The source is exactly one of source_call_id or voice_clip_upload_id; an upload also needs caller_channel_index.

name
string
required

Name of the voice clip set, up to 255 characters.

Required string length: 1 - 255
Example:

"Angry caller, billing dispute"

description
string | null

Optional notes about the voice clip set, up to 10,000 characters.

Maximum string length: 10000
Example:

"Real call where the caller asks for a refund twice."

source_call_id
integer | null

ID of an existing call to take the caller's turns from. Send either this or voice_clip_upload_id, not both.

Required range: x > 0
Example:

1234

voice_clip_upload_id
integer | null

ID of an uploaded recording to take the caller's turns from. Send either this or source_call_id, not both.

Required range: x > 0
Example:

56

caller_channel_index
integer | null

Index of the channel in the uploaded recording that holds the caller's audio. Required with voice_clip_upload_id, and not allowed with source_call_id.

Required range: x >= 0
Example:

0

extraction_settings
Extraction Settings · object | null

Optional overrides, in milliseconds, for merge_gap_ms (caller segments closer than this are merged into one turn, default 400), min_turn_ms (shorter turns are dropped, default 300) and pad_ms (padding added around each turn, default 120). Omit to use the defaults.

Example:

Response

Successful Response

A voice clip set, without 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.