Skip to main content
GET
List Voice Candidates

Authorizations

x-api-key
string
header
required

API key for authentication. Passed via the x-api-key header.

Query Parameters

embedding_id
string | null

Look up a single candidate by id. Omit to list all candidates.

skip
integer
default:0
Required range: x >= 0
limit
integer
default:100
Required range: 1 <= x <= 1000

Response

Successful Response

embeddings
VoiceEmbeddingResponse · object[]
required

Matching candidates, newest first. An id this organization does not hold returns an empty list, so check the list before indexing into it.