Skip to main content
GET
/
api
/
voices
/
{voiceId}
Get voice
curl --request GET \
  --url https://api.upon-ai.com/api/voices/{voiceId} \
  --header 'Authorization: Bearer <token>'
{
  "voiceId": "<string>",
  "name": "<string>",
  "gender": "<string>",
  "language": "<string>",
  "accent": "<string>",
  "description": "<string>",
  "provider": "<string>",
  "previewUrl": "<string>",
  "playbackOverrideUrl": "<string>",
  "tags": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://documentation.uponai.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Generate tokens from your profile settings at app.uponai.com.

Headers

X-Actor-Type
enum<string>

Optional actor type for privileged white-label context selection.

Available options:
platform_admin,
provider_admin,
tenant_admin,
end_user
X-Provider-Id
integer

Optional provider scope identifier for privileged multi-tenant access.

X-Tenant-Id
integer

Optional tenant/workspace context override.

X-Impersonation-Reason
string

Required for privileged tenant-scoped requests when actor type is platform or provider admin.

Path Parameters

voiceId
string
required

Voice identifier.

Query Parameters

workspaceId
integer
required

Workspace identifier. Call GET /api/workspaces to list workspaces accessible to your token.

Response

200 - application/json

Voice metadata.

voiceId
string
required
name
string
required
gender
string
language
string
accent
string
description
string
provider
string
previewUrl
string<uri>
playbackOverrideUrl
string<uri> | null
tags
string[]
createdAt
string<date-time> | null
updatedAt
string<date-time> | null