Skip to content
TipPage Docs
Esc
navigateopen⌘Jpreview

List AI voices

The feature’s current state, the full curated voice catalog with per-voice enabled flags, and this month’s character usage. Voice ids are stable slugs - use them with the per-voice toggles. min_amount is the tip amount that unlocks AI voices on the tip page. Requires ai_voices:manage. Closed beta: answers 404 unless AI voices are enabled for your account.

GET/ai-voices
Authorization
AuthorizationBearer token (tp_live_...) · headerrequired
A TipPage API key, created in Dashboard → Settings → Developer.
Responses
200Feature state, catalog, and usage.
enabledboolean
The master switch - whether donors are offered AI voices.
modestring
`optional` keeps the standard voice as the default; `exclusive` makes every tip message use an AI voice.
Allowed:optionalexclusive
min_amountnumber
Minimum tip amount that unlocks AI voices.
usageobject
This month's character budget (AI generation spends characters).
Show properties
monthstring
characters_usedinteger
characters_limitinteger
characters_remaininginteger
voicesobject[]
Show properties
Array of object
idstring
labelstring
hintstring
genderstring
Allowed:mfx
sample_urlstring
A short sample clip of the voice.
enabledboolean
Whether donors can currently pick this voice.
401Missing or invalid API key (`missing_api_key` / `invalid_api_key`).
errorstringrequired
Human-readable message.
codestring
Machine-readable code (e.g. `missing_scope`, `not_in_queue`).
403The key lacks the required scope (`missing_scope`).
errorstringrequired
Human-readable message.
codestring
Machine-readable code (e.g. `missing_scope`, `not_in_queue`).
required_scopestring
404No such resource.
errorstringrequired
Human-readable message.
codestring
Machine-readable code (e.g. `missing_scope`, `not_in_queue`).
429Rate limit exceeded - check the `RateLimit-*` headers.
errorstring
Request
curl -X GET "https://api.tippage.com/v1/ai-voices" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "enabled": true,
  "mode": "optional",
  "min_amount": 0,
  "usage": {
    "month": "2026-08",
    "characters_used": 0,
    "characters_limit": 0,
    "characters_remaining": 0
  },
  "voices": [
    {
      "id": "leader",
      "label": "Barack Obama",
      "hint": "Smooth presidential orator",
      "gender": "m",
      "sample_url": "string",
      "enabled": true
    }
  ]
}