Skip to content

Speaker Services - Embedding Models

Discover embedding models. Model administration is documented in Admin - Speaker Embedding Models.

Base path: /api/v1/speaker-services

Method Endpoint Description
GET /api/v1/speaker-services/speaker-embeddings/models List Embedding Models
GET /api/v1/speaker-services/speaker-embeddings/models/{model} Get Embedding Model

List Embedding Models

GET /api/v1/speaker-services/speaker-embeddings/models

Requires Authentication - Scopes: speaker:embedding-model-aliases:read

Returns embedding models accessible to the current user. isDefault identifies the current default used when a verification or quality preview omits model.

SpeakerEmbeddingModelAliasResponse[]
SpeakerEmbeddingModelAliasResponse
[
  {
    "id": "speaker-default",
    "type": "FAMILY",
    "displayName": "Speaker Default",
    "description": "Default speaker embedding model",
    "status": "AVAILABLE",
    "resolvedModel": "spk-embed-he-v3",
    "isDefault": true,
    "capabilities": {
      "supportedLocales": ["he-IL", "en-US"]
    },
    "deprecated": false,
    "deprecationDate": null,
    "sunsetDate": null,
    "deprecationMessage": null
  }
]
Status Description
200 OK Accessible models returned.
401 Unauthorized Missing or invalid authentication.
403 Forbidden Insufficient scope.

Get Embedding Model

GET /api/v1/speaker-services/speaker-embeddings/models/{model}

Requires Authentication - Scopes: speaker:embedding-model-aliases:read

Returns details for a specific embedding model.

Path Parameters
Parameter Type Required Description
model string Yes Embedding model.
SpeakerEmbeddingModelAliasResponse
Status Description
200 OK Model returned.
401 Unauthorized Missing or invalid authentication.
403 Forbidden Insufficient scope or model visibility restriction.
404 Not Found Model not found.
410 Gone Model has passed its sunset date.

Data Types

SpeakerEmbeddingModelAliasResponse

Field Type Nullable Description
id string No Model identifier clients pass as model.
type string No Model type: FAMILY, PINNED, or CONCRETE.
displayName string No Human-readable name.
description string Yes Optional description.
status string No Effective status of the resolved model.
resolvedModel string No Model version used for processing.
isDefault boolean No Whether this is the default speaker embedding model.
capabilities SpeakerEmbeddingModelCapabilities No Model capabilities.
deprecated boolean No Whether the model is deprecated.
deprecationDate string (date) Yes Date deprecation started.
sunsetDate string (date) Yes Date after which public requests reject the model.
deprecationMessage string Yes Optional deprecation message.

SpeakerEmbeddingModelCapabilities

Field Type Nullable Description
supportedLocales string[] Yes Supported speaker locales.

SpeakerEmbeddingModelStatus

Value Description
AVAILABLE Model can process embedding inference requests.
DEPRECATED Model is deprecated and is not eligible for new model resolution; historical evidence remains readable.
MAINTENANCE Model is temporarily unavailable.
INACTIVE Model cannot process embedding inference requests.