Get Voice

GET

/api/v1/voices/:voice_id

GET

/api/v1/voices/:voice_id

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

1 {
2   "data": {
3     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4     "name": "Emma",
5     "provider": "aws_polly",
6     "provider_voice_id": "Joanna",
7     "is_active": true,
8     "created_at": "2023-11-20T14:22:00Z",
9     "updated_at": "2024-04-10T08:15:00Z",
10     "description": "A clear and friendly American English female voice, suitable for news and narration.",
11     "gender": "female",
12     "accent": "american",
13     "age": "young",
14     "category": "news",
15     "color": "#4A90E2",
16     "tags": [
17       "news",
18       "clear",
19       "friendly"
20     ],
21     "descriptor": "Bright and engaging news anchor voice",
22     "uses_count": 1245,
23     "user_id": null,
24     "source": "platform",
25     "duration_seconds": 15.3,
26     "sample_url": "https://presigned.onepin.ai/sample/3fa85f64-5717-4562-b3fc-2c963f66afa6?expires=1716105600",
27     "supported_languages": [
28       "en-US"
29     ],
30     "supported_models": [
31       "neural",
32       "standard"
33     ],
34     "is_favorite": false
35   },
36   "meta": {
37     "request_id": "7b9f8e2a-4d3c-4f1a-9b2e-1a2b3c4d5e6f",
38     "timestamp": "2024-04-27T12:00:00Z"
39   }
40 }

Fetch a single voice by its ID.

Returns both platform (system-wide) voices and voices that belong to the caller’s workspace. Returns 404 when the voice does not exist or is not accessible to the caller’s workspace. The sample_url field is a time-limited presigned URL valid for 1 hour; regenerate it by calling this endpoint again rather than caching it long-term.

Authentication

AuthorizationBearer

Clerk JWT token

AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Path parameters

voice_idstringRequiredformat: "uuid"

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Response

Errors