Standard voices, and the main alert box's settings

The standard voices a tip can be read in, and the voice settings of your main alert box, which is what tip audio uses when you pass nothing. Requires tts:read.

GET/tts/voices

Authorization

AuthorizationBearer token (tp_live_... or tpat_...) · headerrequired

A TipPage API key (`tp_live_...`, created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (`tpat_...`, see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.

Responses

200The voices and the default.

standardobject[]

Show properties

Array of object

idstring

labelstring

detailstring

languagestring

defaultobject

The main alert box's resolved settings.

Show properties

voicestring

ratenumber

pitchnumber

read_namesboolean

read_amountsboolean

read_messagesboolean

max_lengthinteger

401Missing or invalid credential (`missing_api_key` / `invalid_api_key`, or `invalid_token` for an expired/revoked OAuth access token).

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

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X GET "https://api.tippage.com/v1/tts/voices" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.tippage.com/v1/tts/voices", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.tippage.com/v1/tts/voices",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "standard": [
    {
      "id": "Emma",
      "label": "string",
      "detail": "English (UK), female",
      "language": "en-GB"
    }
  ],
  "default": {
    "voice": "string",
    "rate": 0,
    "pitch": 0,
    "read_names": true,
    "read_amounts": true,
    "read_messages": true,
    "max_length": 0
  }
}