---
title: "Update a speaker"
method: PATCH
path: "/v1/speakers/{id}"
tags: ["Speakers"]
---

# Update a speaker

`PATCH /v1/speakers/{id}`

## Request

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

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

## Path parameters

- `id` string, required

## Request body

- UpdateSpeakerRequest
  - `name` string, nullable
  - `metadata` object, nullable: Replaces the metadata (up to 16 KB).

## Response `200`

The updated speaker.

- EnrolledSpeaker
  - `id` string, required: Speaker ID.
  - `object` 'speaker', required
  - `name` string, nullable, required: Your label for the speaker.
  - `metadata` object, nullable, required: Your `metadata`.
  - `model` 'aircaps-speaker-id-v1', required
  - `num_enrollments` integer, required
  - `enrolled_duration` number, required: Seconds of enrollment audio in total.
  - `enrollments` SpeakerEnrollment[], required: Oldest first. Only embeddings are stored, never the audio.
    - `id` string, required: Enrollment ID.
    - `object` 'speaker_enrollment', required
    - `speaker_id` string, required
    - `audio_duration` number, required: Seconds of audio in the enrollment clip.
    - `consistency` number, nullable, 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.
    - `created_at` string, date-time, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required: Last change to the name, metadata or enrollments.

## Other responses

- `400`: Invalid request. Codes: `invalid_request`.
- `401`: Missing or invalid API key. Codes: `unauthorized`.
- `403`: The account may not do this. Codes: `account_suspended`, `account_disabled`.
- `404`: Not found. Codes: `speaker_not_found`, `enrollment_not_found`.
- `500`: Server error. Safe to retry (use the same Idempotency-Key). Codes: `internal_error`.
- `503`: Temporarily unavailable. Retry after the Retry-After interval. Codes: `service_unavailable`.

---

[API](https://skmtc.dev/aircaps/apis/aircaps-api.md) - [All operations](https://skmtc.dev/aircaps/apis/aircaps-api/llms.txt) - [OpenAPI document](https://skmtc.dev/aircaps/apis/aircaps-api/revisions/442d566f9827?raw)