AIaircaps
Speakers

Update a speaker

Change the name or metadata. Omitted fields stay as they are; null clears one.

patch/v1/speakers/{id}

Request

  • Base URL
    https://api.aircaps.com
  • URL
    https://api.aircaps.com/v1/speakers/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:spk_01k73a9x8w7v6u5t4s3r2q1p0n

Speaker ID.

Request body

namestring nullable
metadataobject nullable

Replaces the metadata (up to 16 KB).

Response

The updated speaker.

idstring required

Speaker ID.

object'speaker' required
namestring nullable required

Your label for the speaker.

metadataobject nullable required

Your metadata.

model'aircaps-speaker-id-v1' required
num_enrollmentsinteger required
enrolled_durationnumber required

Seconds of enrollment audio in total.

created_atstring date-time required
updated_atstring date-time required

Last change to the name, metadata or enrollments.

Example response

{
  "id": "spk_01k73a9x8w7v6u5t4s3r2q1p0n",
  "name": "Ana García",
  "metadata": {
    "employee_id": "E-1042"
  },
  "num_enrollments": 2,
  "enrolled_duration": 27.9,
  "enrollments": [
    {
      "id": "enr_01k73b2c4d5e6f7g8h9j0k1m2n",
      "speaker_id": "spk_01k73a9x8w7v6u5t4s3r2q1p0n",
      "audio_duration": 12.48,
      "consistency": 0.712
    }
  ]
}

Changes

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