Speakers

Identify a speaker

Score one clip against your enrolled speakers: every speaker (or the ones in speaker_ids), best first, with a similarity score for each speaker's profile and for each enrollment. Synchronous: the result is the response. No threshold is applied; see Speaker ID.

post/v1/speakers/identify

Request

Base URL
https://api.aircaps.com
URL
https://api.aircaps.com/v1/speakers/identify
Auth
HTTP bearer

Query parameters

speaker_idsstring

Example:spk_01k73a9x8w7v6u5t4s3r2q1p0n,spk_01k73a7m6n5b4v3c2x1z0l9k8j

Only these speakers: comma-separated, or the parameter repeated. Default: every enrolled speaker of the account. Verification of one person is speaker_ids=<their id>.

top_kinteger

Return only the best top_k results (all speakers are still scored; margin and speakers_compared are unchanged).

model'aircaps-speaker-id-v1'

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

Headers

Content-Typestring

The clip's media type, for example audio/wav. Informational: the format is detected from the bytes.

Request body application/octet-stream

string binary required

Response

The scores.

idstring required

Identification ID (identifies the request; identifications are not stored).

object'speaker_identification' required

model'aircaps-speaker-id-v1' required

created_atstring date-time required

audio_durationnumber required

Seconds of audio in the clip.

speakers_comparedinteger required

Speakers the clip was scored against (before top_k).

marginnumber nullable required

Best score minus the second best. null with one speaker.

Example response

{
  "id": "sid_01k73c0q9w8e7r6t5y4u3i2o1p",
  "audio_duration": 4.21,
  "speakers_compared": 3,
  "margin": 0.476,
  "results": [
    {
      "speaker_id": "spk_01k73a9x8w7v6u5t4s3r2q1p0n",
      "name": "Ana García",
      "score": 0.684,
      "enrollment_scores": [
        {
          "score": 0.661
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.