Workflow
1
Create a transcript request
Submit the public source URL with
POST /api/transcripts/v1/requests/.2
Poll the request
Use
GET /api/transcripts/v1/requests/{id}/ until status is FINISHED or ERROR. Poll about every 15 minutes.3
Assign speaker names, if needed
After the transcript is finished, send speaker profiles to
POST /api/transcripts/v1/requests/{id}/assign-speakers/.Create a request
id; use that ID to poll status and assign speaker names.
string
required
Public
https:// URL for the audio or video source to transcribe.Get request status and results
string
required
Transcript request ID returned when you created the request. This ID is a UUID-formatted string.
string
Unique transcript request ID. This ID is a UUID-formatted string.
string
Original URL submitted for transcription.
integer
Internal source ID associated with the transcript data.
string
Title detected for the source, when available.
string
Request-level status. Possible values include
QUEUED, RECORDING, TRANSCRIBING, DIARIZING, FINISHED, ERROR, and CANCELED.string
Source-level transcript processing status.
string
Full transcript text. This is available when transcription has completed. If speaker names have been assigned, the text uses the assigned names.
object
Structured transcript data.
array
Speaker profiles currently stored on the request.
string
Error message if the request failed.
string
Time the request was created in ISO 8601 format.
string
Time the request was last updated in ISO 8601 format.
List your requests
Assign speaker names
status is FINISHED to map transcript speaker labels to the people you provide in speaker_profiles.
string
required
Transcript request ID returned when you created the request. This ID is a UUID-formatted string.
array
required
List of speaker profiles to assign.
Speaker profile guidance
Use stable string IDs and include aliases that may appear in the transcript.Example speaker profiles