Skip to main content
PATCH
Edit or Verify a Voice Clip

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
turn_index
integer
required
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 editing and/or verifying one clip of a voice clip set.

Saving a transcript edit always verifies the clip, so verified=false together with reference_transcript is a contradiction and is rejected. An empty reference_transcript is valid (a silent clip).

reference_transcript
string | null

Corrected transcript of what the caller said. Saving it also marks the clip as verified. An empty string is valid for a silent clip.

Maximum string length: 5000
verified
boolean | null

Set to true to confirm the current transcript as correct, or false to clear the confirmation. Cannot be false together with reference_transcript.

Response

Successful Response

A single caller-turn clip within a voice clip set, in playback order.

id
integer
required

Clip ID.

turn_index
integer
required

Position of the clip in the set, in playback order.

start_ms
integer
required

Start of the clip in the caller track, in milliseconds.

end_ms
integer
required

End of the clip in the caller track, in milliseconds.

duration_ms
integer
required

Length of the clip in milliseconds.

reference_transcript
string | null

Transcript of what the caller said in the clip, if available.

verified
boolean
default:false

Whether a person has checked this clip's transcript.

verified_at
string<date-time> | null

When the transcript was verified. Empty if it is not verified.

verified_by
integer | null

ID of the user who verified it.

reference_version
integer
default:1

Goes up each time the transcript is edited.

draft_source
string | null

Which speech-to-text model or voice platform produced the first draft.