Submit Voiceprint Job

Extract voiceprint

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
}
'

import requests

url = "https://api.pyannote.ai/v1/voiceprint"

payload = {
    "url": "https://example.com/voice.wav",
    "model": "precision-2",
    "webhook": "https://example.com/webhook",
    "webhookStatusOnly": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/voice.wav',
    model: 'precision-2',
    webhook: 'https://example.com/webhook',
    webhookStatusOnly: true
  })
};

fetch('https://api.pyannote.ai/v1/voiceprint', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pyannote.ai/v1/voiceprint",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/voice.wav',
    'model' => 'precision-2',
    'webhook' => 'https://example.com/webhook',
    'webhookStatusOnly' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pyannote.ai/v1/voiceprint"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/voice.wav\",\n  \"model\": \"precision-2\",\n  \"webhook\": \"https://example.com/webhook\",\n  \"webhookStatusOnly\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pyannote.ai/v1/voiceprint")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/voice.wav\",\n  \"model\": \"precision-2\",\n  \"webhook\": \"https://example.com/webhook\",\n  \"webhookStatusOnly\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pyannote.ai/v1/voiceprint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/voice.wav\",\n  \"model\": \"precision-2\",\n  \"webhook\": \"https://example.com/webhook\",\n  \"webhookStatusOnly\": true\n}"

response = http.request(request)
puts response.read_body

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

{
  "message": "Invalid request",
  "errors": [
    {
      "field": "url",
      "message": "Invalid URL"
    }
  ]
}

{
  "requestId": "37a4c3a0-b034-4e8c-9ed9-76da6645544a",
  "message": "Error message"
}

{
  "requestId": "37a4c3a0-b034-4e8c-9ed9-76da6645544a",
  "message": "Error message"
}

POST

voiceprint

Extract voiceprint

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
}
'

import requests

url = "https://api.pyannote.ai/v1/voiceprint"

payload = {
    "url": "https://example.com/voice.wav",
    "model": "precision-2",
    "webhook": "https://example.com/webhook",
    "webhookStatusOnly": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/voice.wav',
    model: 'precision-2',
    webhook: 'https://example.com/webhook',
    webhookStatusOnly: true
  })
};

fetch('https://api.pyannote.ai/v1/voiceprint', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pyannote.ai/v1/voiceprint",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/voice.wav',
    'model' => 'precision-2',
    'webhook' => 'https://example.com/webhook',
    'webhookStatusOnly' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pyannote.ai/v1/voiceprint"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/voice.wav\",\n  \"model\": \"precision-2\",\n  \"webhook\": \"https://example.com/webhook\",\n  \"webhookStatusOnly\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pyannote.ai/v1/voiceprint")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/voice.wav\",\n  \"model\": \"precision-2\",\n  \"webhook\": \"https://example.com/webhook\",\n  \"webhookStatusOnly\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pyannote.ai/v1/voiceprint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/voice.wav\",\n  \"model\": \"precision-2\",\n  \"webhook\": \"https://example.com/webhook\",\n  \"webhookStatusOnly\": true\n}"

response = http.request(request)
puts response.read_body

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

{
  "message": "Invalid request",
  "errors": [
    {
      "field": "url",
      "message": "Invalid URL"
    }
  ]
}

{
  "requestId": "37a4c3a0-b034-4e8c-9ed9-76da6645544a",
  "message": "Error message"
}

{
  "requestId": "37a4c3a0-b034-4e8c-9ed9-76da6645544a",
  "message": "Error message"
}

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

Voiceprint output is deleted 24 hours after job completion

Generated voiceprints are job output. They are not added to a reusable voiceprint database for your account.
Retrieve and store the voiceprint in your own system before it is deleted.
See Data retention for the full policy.

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

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

Introduction

Test

Jobs

Streaming

Media

Schemas

Submit Voiceprint Job

Authorizations

Body

Response