gistfile1.txt

Flowery Logo
Flowery API
API Base: api.flowery.pw | OpenAPI specification

Before You Start...
User Agent Required
You must provide a 
valid
 User-Agent header for all requests made to the Flowery API. Requests without a valid User-Agent will be rejected with a 403 status code.
Rate Limits
Flowery limits you to 3 requests per second and 20 requests per minute when generating audio. Cached requests are not counted towards your limit.
Need higher limits? Contact us at contact@flowery.pw

Commercial Use
Flowery is a non-commercial service provided free of charge and you are prohibited from charging for or monetizing any of Flowery's services.
Join Our Community
To help stay up-to-date and get support, it's recommended to join the Flowery Discord server.
GET /v1/tts
Use this endpoint to generate audio. While Flowery intends to be as fast as possible, the time it takes to generate audio can vary depending on the length of the text and the selected voice. If your HTTP client has a timeout set too low, you may experience a timeout error.

Parameter	Type	Required	Default	Description
text	string	Yes	-	This is the text for the voice to synthesize. There is a limit of 2048 characters; anything over will be truncated.
voice	string	No	-	Using the voice ID is highly recommended; however, for legacy reasons, names are still supported. Keep in mind that some voices may be inaccessible if names are used due to duplicates.
translate	boolean	No	false	Whether the text should be translated to the voice's set language before being synthesized.
silence	integer	No	0	The amount of empty space (in milliseconds) to add to the beginning and end of the audio. Supported range is 0-10000.
audio_format	string	No	mp3	Supported formats: mp3, ogg_opus, ogg_vorbis, aac, wav, and flac.
speed	float	No	1.0	Supported range is 0.5 - 10, in increments of 0.1.
Responses
200 Success
400 Bad Request
422 Validation Error
429 Rate Limited
500 Server Error
You'll receive the audio file in the requested format.

GET /v1/tts/voices
Use this endpoint to find the available voices. Keep in mind that this list is dynamic and may change occasionally, so you should fetch it frequently to keep your application up-to-date. Don't rely on anything staying the exact same, except for the structure of the response.

200 Success
422 Validation Error
500 Server Error
Response Schema
Schema

Response
{
  "count": "integer",
  "default": {
    "id": "string",
    "name": "string",
    "gender": "string",
    "source": "string",
    "language": {
      "name": "string",
      "code": "string"
    }
  },
  "voices": [
    {
      "id": "string",
      "name": "string",
      "gender": "string",
      "source": "string",
      "language": {
        "name": "string",
        "code": "string"
      }
    }
  ]
}

The Flowery API client reqiures you store your authentication key in a file ~/.flowery/token.txt. Any token works but it mist be secret