Audio for a queued tip

The clip for a queued tip, made on demand. A standard-voice tip’s audio is only made when something comes to play it, so a consumer that plays tips itself asks here before or after claiming; an AI-voice tip’s clip was made at payment and is handed straight back. The words come from the row’s current name, amount and message. The first clip made for a tip is written to the queue row as tts_url and fires tip.tts_ready.

Pass nothing to get your main alert box’s voice, overlay to get a particular overlay’s alert box voice, or the voice parameters directly, which override either. Only tips still in the queue can be asked for (a played one is 404 not_in_queue). No rate limit; up to 8 distinct voice variants per tip. The same parameters are accepted in a JSON body on POST. Requires tts:read.

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

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

import requests

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

{
  "url": "http://example.com",
  "text": "string",
  "cached": true,
  "provider": "string",
  "ai": {
    "voiced": true,
    "turns": [
      {}
    ]
  }
}

{
  "error": "string",
  "code": "string"
}

{
  "error": "string",
  "code": "string"
}

{
  "error": "string",
  "code": "string",
  "required_scope": "string"
}

{
  "error": "string",
  "code": "string"
}

{
  "error": "string",
  "code": "string"
}

{
  "fallback": true,
  "text": "string",
  "error": "string"
}