Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Your API key: Authorization: Bearer aircaps_sk_...

Path Parameters

id
string
required

Speaker ID.

Example:

"spk_01k73a9x8w7v6u5t4s3r2q1p0n"

Query Parameters

model
enum<string>

Optional: aircaps-speaker-id-v1. Any other value returns 400 unsupported_model.

Available options:
aircaps-speaker-id-v1

Body

The clip's raw audio bytes (any common audio or video format; channels are mixed down and audio is resampled to 16 kHz). Not multipart form data. The whole clip is used as given: crop it to one person's speech first.

The body is of type file.

Response

Enrolled.

id
string
required

Enrollment ID.

Example:

"enr_01k73b2c4d5e6f7g8h9j0k1m2n"

object
enum<string>
required
Available options:
speaker_enrollment
speaker_id
string
required
Example:

"spk_01k73a9x8w7v6u5t4s3r2q1p0n"

audio_duration
number
required

Seconds of audio in the enrollment clip.

Example:

12.48

consistency
number | null
required

How well this enrollment matches the speaker's other enrollments (-1 to 1). null when it is the only one. A value much lower than the speaker's other enrollments suggests a clip of someone else or a poor recording.

Example:

0.712

created_at
string<date-time>
required
speaker
object