Skip to main content
POST
Create a speaker

Authorizations

Authorization
string
header
required

Your API key: Authorization: Bearer aircaps_sk_...

Body

application/json
model
enum<string>

Optional. Any other value returns 400 unsupported_model.

Available options:
aircaps-speaker-id-v1
name
string | null

Your label for the speaker (whitespace is collapsed). Optional.

Maximum string length: 200
Example:

"Ana García"

metadata
object | null

Any JSON object up to 16 KB.

Example:

Response

Created.

id
string
required

Speaker ID.

Example:

"spk_01k73a9x8w7v6u5t4s3r2q1p0n"

object
enum<string>
required
Available options:
speaker
name
string | null
required

Your label for the speaker.

Example:

"Ana García"

metadata
object | null
required

Your metadata.

Example:
model
enum<string>
required
Available options:
aircaps-speaker-id-v1
num_enrollments
integer
required
Example:

2

enrolled_duration
number
required

Seconds of enrollment audio in total.

Example:

27.9

enrollments
object[]
required

Oldest first. Only embeddings are stored, never the audio.

created_at
string<date-time>
required
updated_at
string<date-time>
required

Last change to the name, metadata or enrollments.