For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
  • API Reference
      • GETList Voices
      • GETGet Voice
      • GETGet Similar Voices
      • POSTFavorite Voice
      • DELUnfavorite Voice
  • Python SDK
    • Install
    • Usage
    • Errors
  • CLI
    • Overview
LogoLogo
API Referencevoices

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 Voice",
6      "provider": "AcmeTTS",
7      "provider_voice_id": "emma_us_01",
8      "is_active": true,
9      "created_at": "2023-11-20T14:22:00Z",
10      "updated_at": "2024-04-10T10:15:00Z",
11      "similarity_score": 0.92,
12      "description": "Clear and friendly American English female voice",
13      "gender": "female",
14      "accent": "american",
15      "age": "young",
16      "category": "narration",
17      "color": "#FF5733",
18      "tags": [
19        "friendly",
20        "clear",
21        "narration"
22      ],
23      "descriptor": "Warm and engaging tone suitable for audiobooks",
24      "uses_count": 245,
25      "user_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
26      "source": "platform",
27      "duration_seconds": 12.5,
28      "sample_url": "https://cdn.onepin.ai/samples/emma_us_01.mp3",
29      "supported_languages": [
30        "en-US",
31        "en-GB"
32      ],
33      "is_favorite": false
34    }
35  ],
36  "meta": {
37    "request_id": "7b9f8e2a-3c4d-4f1a-9b2e-1a2b3c4d5e6f",
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.
Was this page helpful?
Previous

Favorite Voice

Next
Built with

Authentication

AuthorizationBearer
Clerk JWT token

Path parameters

voice_idstringRequiredformat: "uuid"

Headers

X-Workspace-Idstring or nullOptional

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