v1

latestOpenAPI 3.0.02026-07-2693126.7 KB

Api

Operations

Diarize audio

post/v1/diarize

Request body

urlstring required

URL of the audio file to be processed

webhookstring

Webhook URL to receive results when job is completed (optional)

webhookStatusOnlyboolean

When true, webhook payload only includes jobId and status (excludes output). Useful for large payloads.

model'precision-2' | 'community-1' nullable

numSpeakersnumber

Number of speakers. Only use if the number of speakers is known in advance. Number of speakers is detected automatically if not provided. Setting this value results in better overall diarization performance. In rare cases where we cannot honor this request (e.g. short files and large number of speakers), a warning will be added to the output. Equivalent to sending minSpeakers==maxSpeakers

minSpeakersnumber

Minimum number of speakers (must be <= maxSpeakers if both are set)

maxSpeakersnumber

Maximum number of speakers (must be >= minSpeakers if both are set)

turnLevelConfidenceboolean nullable

Includes turn-level confidence values in the output.

exclusiveboolean

Includes exclusive diarization values in the output in exclusiveDiarization key (equivalent to diarization but without overlapping speech).

confidenceboolean

Include confidence values in the output. Output is considerably larger when this option is enabled. Output includes a list of confidence scores with a resolution.

transcriptionboolean

Enable speaker attributed transcription. Only available for the precision-2 diarization model.

Example request

{
  "url": "https://example.com/audio.wav",
  "webhook": "https://example.com/webhook",
  "webhookStatusOnly": true,
  "model": "precision-2",
  "numSpeakers": 2,
  "minSpeakers": 1,
  "maxSpeakers": 4,
  "turnLevelConfidence": true,
  "exclusive": true,
  "confidence": true,
  "transcriptionConfig": {
    "model": "faster-whisper-large-v3-turbo"
  }
}

Response

jobIdstring required

ID of the job

Status of the job

warningstring

Warning message if any

Example response

{
  "jobId": "3c8a89a5-dcc6-4edb-a75d-ffd64739674d",
  "status": "created"
}