Create Voice Clip Set
Create a voice clip set from a call or an uploaded recording.
The clips are cut asynchronously: the set is returned in extracting status. Poll Get
Voice Clip Set until it is ready.
Authorizations
Use Tuner API key (tr_api_...) or user session token. Find your API key in Workspace Settings > API Keys.
Path Parameters
Tuner's internal numeric ID for the agent.
Workspace ID. Find this in Workspace > General Settings.
Body
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 of the voice clip set, up to 255 characters.
1 - 255"Angry caller, billing dispute"
Optional notes about the voice clip set, up to 10,000 characters.
10000"Real call where the caller asks for a refund twice."
ID of an existing call to take the caller's turns from. Send either this or voice_clip_upload_id, not both.
x > 01234
ID of an uploaded recording to take the caller's turns from. Send either this or source_call_id, not both.
x > 056
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.
x >= 00
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.
Response
Successful Response
A voice clip set, without its clips.
Voice clip set ID.
Name of the voice clip set.
extracting while the caller's clips are being cut, ready once the set can be replayed, or failed.
Number of clips in the set.
When the voice clip set was created.
Notes about the voice clip set.
Combined length of all clips in milliseconds. Set once ready.
Length of the full caller audio track in milliseconds. Set once ready.
ID of the call the set was built from, if it came from a call.
ID of the upload the set was built from, if it came from an upload.
Whether the source recording was mono or multi_channel.
Why extraction failed. Set only when status is failed.
Goes up whenever any clip's transcript is edited, verified or unverified.
Number of clips whose transcript has been verified.