Get Similar Voices

GET

/api/v1/voices/:voice_id/similar

GET

/api/v1/voices/:voice_id/similar

$ curl https://api.onepin.ai/api/v1/voices/voice_id/similar \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5       "name": "Emma Johnson",
6       "provider": "AcmeVoice",
7       "provider_voice_id": "acme-voice-1234",
8       "is_active": true,
9       "created_at": "2024-01-15T09:30:00Z",
10       "updated_at": "2024-04-10T14:45:00Z",
11       "similarity_score": 0.92,
12       "description": "Clear and friendly American English female voice suitable for news narration.",
13       "gender": "female",
14       "accent": "american",
15       "age": "young",
16       "category": "news",
17       "color": "#FF5733",
18       "tags": [
19         "news",
20         "clear",
21         "friendly"
22       ],
23       "descriptor": "Bright and engaging tone",
24       "uses_count": 245,
25       "user_id": "9b2d7f4e-8c3a-4f1a-9d2e-1a2b3c4d5e6f",
26       "source": "platform",
27       "duration_seconds": 12.5,
28       "sample_url": "https://samples.onepin.ai/voices/emma_johnson_sample.mp3",
29       "supported_languages": [
30         "en-us",
31         "en-ca"
32       ],
33       "is_favorite": false
34     }
35   ],
36   "meta": {
37     "request_id": "7f9c2ba4-1d3e-4f6a-8b2c-9d7e5f1a2b3c",
38     "timestamp": "2024-06-01T12:00:00Z"
39   },
40   "pagination": {
41     "limit": 10,
42     "next": "https://api.onepin.ai/api/v1/voices/3fa85f64-5717-4562-b3fc-2c963f66afa6/similar?limit=10&page=2",
43     "prev": null
44   }
45 }

Return voices nearest to a reference voice embedding.

Authentication

AuthorizationBearer

Clerk JWT token

Path parameters

voice_idstringRequiredformat: "uuid"

Query parameters

limitintegerOptional1-50Defaults to 10

languagelist of strings or nullOptional

Repeat for OR, e.g. ?language=en-us&language=ko-kr

Response

Successful Response

datalist of objects

metaobject

paginationobject

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors