Submit Voiceprint Job

POST /v1/voiceprint

Extract voiceprint

cURL

curl --request POST \
  --url https://api.pyannote.ai/v1/voiceprint \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/voice.wav",
  "model": "precision-2",
  "webhook": "https://example.com/webhook",
  "webhookStatusOnly": true
}
'

200

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

This endpoint allows you to create a new voiceprint from a remote audio URL.

For a complete guide on creating and using voiceprints for speaker identification, see the Identification with Voiceprints tutorial.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

url · string · required

URL of the voiceprint audio file

Example:

"https://example.com/voice.wav"

model · enum<string> | null · default: precision-2

Available options: precision-2

Example:

"precision-2"

webhook · string

Webhook URL to receive voiceprint results (optional)

Example:

"https://example.com/webhook"

webhookStatusOnly · boolean · default: false

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

Example:

true

Response

200

application/json

jobId · string · required

ID of the job

Example:

"3c8a89a5-dcc6-4edb-a75d-ffd64739674d"

status · enum<string> · required

Status of the job

Available options: pending, created, succeeded, canceled, failed, running

Example:

"created"

warning · string

Warning message if any