Voiceprints

Enroll Voiceprint

post

Enroll a speaker voiceprint for an entity.

Accepts PCM16 audio (wav or raw bytes). Proxies to emotion-engine for ECAPA-TDNN embedding extraction, then stores the result as a world event on the person entity.

Permissions: admin, owner.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

multipart/form-data

audiostringRequired

entity_idany ofRequired

stringOptional

or

string · uuidOptional

sample_rateintegerOptionalDefault: 16000

Responses

201

Successful Response

application/json

enrolledbooleanOptionalDefault: true

entity_idstring · uuidRequired

model_idstringRequired

dimensionsintegerOptionalDefault: 192

400

Bad Request

422

Validation Error

application/json

503

Service Unavailable

post

/v1/{workspace_id}/voiceprints/enroll

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/voiceprints/enroll HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 55

{
  "audio": "text",
  "entity_id": "text",
  "sample_rate": 16000
}

{
  "enrolled": true,
  "entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "model_id": "text",
  "dimensions": 192
}

Get Voiceprint Status

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

entity_idstring · uuidRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/{workspace_id}/voiceprints/{entity_id}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/voiceprints/{entity_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enrolled": true,
  "model_id": "text",
  "enrolled_at": "text"
}

Verify Voiceprint

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

multipart/form-data

audiostringRequired

entity_idany ofRequired

stringOptional

or

string · uuidOptional

sample_rateintegerOptionalDefault: 16000

Responses

200

Successful Response

application/json

400

Bad Request

404

Not Found

422

Validation Error

application/json

503

Service Unavailable

post

/v1/{workspace_id}/voiceprints/verify

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/voiceprints/verify HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 55

{
  "audio": "text",
  "entity_id": "text",
  "sample_rate": 16000
}

{
  "verified": true,
  "similarity": 1,
  "entity_id": "123e4567-e89b-12d3-a456-426614174000"
}