Skip to content

Speaker Services - Embedding Models

Discover embedding model aliases. Admin endpoints for managing concrete embedding models and aliases are 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 Model Aliases
GET /api/v1/speaker-services/speaker-embeddings/models/{model} Get Embedding Model Alias

List Embedding Model Aliases

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

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

Returns embedding model aliases accessible to the current user.

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

Get Embedding Model Alias

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

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

Returns details for a specific embedding model alias.

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

Data Types

SpeakerEmbeddingModelAliasResponse

Field Type Nullable Description
id string No Alias identifier clients pass as model.
type string No Alias 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 Concrete resolved model name as a string.
capabilities SpeakerEmbeddingModelCapabilities No Model capabilities.
deprecated boolean No Whether the alias is deprecated.
deprecationDate string (date) Yes Date deprecation started.
sunsetDate string (date) Yes Date after which public requests reject the alias.
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 remains usable for existing voice prints during migration.
MAINTENANCE Model is temporarily unavailable.
INACTIVE Model cannot process embedding inference requests.