apiaudio 0.9.0

Python SDK for api.audio API

SDK Rename notice 👉 aflr is now apiaudio

[14th July 2021] The SDK has been renamed. aflr v0.8.1 is still up in pip (pypi), but will not be maintained with this name. Please start using apiaudio instead 👉 pip install apiaudio, and change the name from aflr to apiaudio in your requirements file.

apiaudio - python SDK

---

apiaudio is the official api.audio Python 3 SDK. This SDK provides easy access to the api.audio API from applications written in python.

📝 Table of Contents

• About
• Getting Started
• Hello World
• Documentation
  • Import
  • Authentication
  • Authentication with environment variable
  • Resource usage
  • Script
  • Speech
  • Voice
  • Sound
  • Mastering
  • File
  • SyncTTS
• Authors
• License

🧐 About

This repository is actively maintained by Aflorithmic Labs. For examples, recipes and api reference see the api.audio docs.

🏁 Getting Started

Installation

You don't need this source code unless you want to modify it. If you want to use the package, just run:

pip install apiaudio -U

Install from source with:

python setup.py install

Prerequisites

Python 3.6+

🚀 Hello World

Create a file hello.py

touch hello.py

Authentication

The library needs to be configured with your account's secret key which is available in your api.audio Console. Import the apiaudio package and set apiaudio.api_key with the api-key you got from the console:

import apiaudio
apiaudio.api_key = "your-key"

Create Text to audio in 4 steps

Let's create our first audio from text.

✍️ Create a new script:

script = apiaudio.Script.create(scriptText="Hello world", scriptName="hello")
print(script)

🎤 Create an speech audio file from the script using Joanna's voice:

response = apiaudio.Speech.create(scriptId=script["scriptId"], voice="Joanna")
print(response)

🎧 Now let's master the speech file with high quality and a nice background track.

response = apiaudio.Mastering.create(
	scriptId=script.get("scriptId"),
	backgroundTrackId="full__citynights.wav"
	)
print(response)

🎉 Finally, get the urls of the audio files generated:

urls = apiaudio.Mastering.retrieve(scriptId=script["scriptId"])
print(urls)

Or download the files in your current folder:

filepath = apiaudio.Mastering.download(scriptId=script["scriptId"], destination=".")
print(filepath)

Easy right? 🔮 This is the hello.py final picture:

import apiaudio
apiaudio.api_key = "your-key"

# script creation
script = apiaudio.Script.create(scriptText="Hello world", scriptName="hello")

# speech creation
response = apiaudio.Speech.create(scriptId=script["scriptId"], voice="Joanna")
print(response)

# mastering process
response = apiaudio.Mastering.create(
	scriptId=script.get("scriptId"),
	backgroundTrackId="full__citynights.wav"
	)
print(response)

# get url of audio tracks generated
urls = apiaudio.Mastering.retrieve(scriptId=script["scriptId"])
print(urls)

# or download
filepath = apiaudio.Mastering.download(scriptId=script["scriptId"], destination=".")
print(filepath)

Now let's run the code:

python hello.py

Once completed, check the files in the hello.py root folder - you will see a new audio file. Play it!

📑 Documentation

Import

import apiaudio

Authentication

The library needs to be configured with your account's secret key which is available in your Aflorithmic Dashboard. Set apiaudio.api_key with the api-key you got from the dashboard:

apiaudio.api_key = "your-key"

Authentication with environment variable (recommended)

You can also authenticate using apiaudio_key environment variable and the apiaudio SDK will automatically use it. To setup, open the terminal and type:

export apiaudio_key=<your-key>

If you provide both environment variable and apiaudio.api_key authentication, the apiaudio.api_key will be used.

Resource Usage

There are two approaches to use the resources. First approach is to import the resource classes you want to use first, then use resource methods. For example, to use Script, we could do:

from apiaudio import Script
Script.create()

The second approach is to use it directly from apiaudio:

import apiaudio
apiaudio.Script.create()

Same logic applies for other resources (Speech, Voice, Sound...)

Script resource

The Script resource/class allows you to create, retrieve and list scripts. Learn more about scripts here.

Script methods are:

• create() - Create a new script.
  • Parameters:
    • scriptText * [Required] (string) - Text for your script. A script can contain multiple sections and SSML tags. Learn more about scriptText details here
    • projectName (string) - The name of your project. Default value is "default"
    • moduleName (string) - The name of your module. Default value is "default"
    • scriptName (string) - The name of your script. Default value is "default"
    • scriptId (string) - Custom identifier for your script. If scriptId parameter is used, then projectName, moduleName and scriptName are required parameters.
  • Example:

    script = apiaudio.Script.create(
        scriptText="<<sectionName::hello>> Hello {{username|buddy}} <<sectionName::bye>> Good bye from {{location|barcelona}}",
        projectName="myProject",
        moduleName="myModule",
        scriptName="myScript",
        scriptId="id-1234"
        )
    

• retrieve() - Retrieve a script by id.
  • Parameters:
    • scriptId * [Required] (string) - The script ID you want to retrieve.
  • Example:

    script = apiaudio.Script.retrieve(scriptId="id-1234")
    

• list() - List all scripts available in your organization.
  • Parameters:
    • No parameters required.
  • Example:

    scripts = apiaudio.Script.list()
    

• get_random_text() - Retrieve random text from a list of categories.
  • Parameters:
    • category (string) - The category from which the random text is retrieved. If no category is specified, the function defaults to "FunFact"
  • Example:

    text = apiaudio.Script.get_random_text(category="BibleVerse")
    

    • Categories currently available: "BibleVerse", "FunFact", "InspirationalQuote", "Joke", "MovieSynopsis", "Poem", "PhilosophicalQuestion", "Recipe", "TriviaQuestion".

Speech resource

Speech allows you to do Text-To-Speech (TTS) with our API using all the voices available. Use it to create a speech audio file from your script.

Speech methods are:

• create() Send a Text-To-Speech request to our Text-To-Speech service.

  • Parameters:
    • scriptId * [Required] (string) - The script ID
    • voice (string) - Voice name. See the list of available voices using Voice resource. Default voice is "Joanna".
    • speed (string) - Voice speed. Default speed is 100.
    • effect (string) - Put a funny effect in your voice. You can try the following ones: dark_father, chewie, 88b, 2r2d, volume_boost_low volume_boost_middle volume_boost_high (Volume boost allows you to adjust the volume of speech. NOTE! Volume boost effect only applies to speech creation and will be overwritten by the mastering process)
    • silence_padding (integer) - Add a silence padding to your speech tracks (in milliseconds). Default is 0 (no padding)
    • audience (dictionary) - List of dicts containing the personalisation parameters as key-value pairs. This parameter depends on the number of parameters you used in your script resource. For instance, if in the script resource you have scriptText="Hello {{name}} {{lastname}}", the audience should be: [{"username": "Elon", "lastname": "Musk"}]
    • sections (dictionary) is a dictionary (key-value pairs), where the key is a section name, and the value is another dictionary with the section configuration ( valid parameters are: voice, speed, effect, silence_padding). If a section is not found here, the section will automatically inherit the voice, speed, effect and silence_padding values you defined above (or the default ones if you don't provide them). See an example below with 2 sections and different configuration parameters being used.

      sections={
          "firstsection": {
              "voice": "Matthew",
              "speed": 110,
              "silence_padding": 100,
              "effect": "dark_father"
          },
          "anothersection": {
              "voice": "en-GB-RyanNeural",
              "speed": 100
          }
      }
      

    • voiceName (DEPRECATED, use voice instead)
    • scriptSpeed(DEPRECATED, use speed instead)
  • Simple example:

    response = apiaudio.Speech.create(
        scriptId="id-1234",
        voice="Joanna"
        )
    

  • Complete example:

    response = apiaudio.Speech.create(
        scriptId="id-1234",
        voice="Matthew",
        speed=100,
        effect="dark_father",
        silence_padding= 1000,
        audience=[{"username": "Elon", "lastname": "Musk"}],
        sections={
            "firstsection": {
                "voice": "Matthew",
                "speed": 110,
                "silence_padding": 100,
                "effect": "dark_father"
            },
            "anothersection": {
                "voice": "en-GB-RyanNeural",
            }
        }
    )
    

• retrieve() Retrieve the speech file urls.

  • Parameters:
    • scriptId * [Required] (string) - The script ID you want to retrieve.
    • section (string) - The script section name for the first section. The default name for a script section is "default". NOTE: At the moment, Only scripts with 1 section are supported. If the scripts contain more than one section, only the first section can be retrieved.
    • parameters (dict) - Dict containing the personalisation parameters for the first section of the script. This parameter depends on the parameters you used in your script's resource section. If this parameter is used, section must be specified.
  • Example:

    audio_files = apiaudio.Speech.retrieve(scriptId="id-1234")
    

• download() Download the speech files in your preferred folder.

  • Parameters:
    • scriptId * [Required] (string) - The script ID you want to download
    • section (string) - The script section name for the first section. The default name for a script section is "default". NOTE: At the moment, Only scripts with 1 section are supported. If the scripts contain more than one section, only the first section can be retrieved.
    • parameters (dict) - Dict containing the personalisation parameters for the first section of the script. This parameter depends on the parameters you used in your script's resource section. If this parameter is used, section must be specified.
    • destination (string) - The folder destination path. Default is "." (current folder)
  • Example:

    audio_files = apiaudio.Speech.download(scriptId="id-1234", destination=".")
    

Voice resource

Voice allows you to retrieve a list of the available voices from our API.

Voice methods are:

• list() List all the available voices in our API. The parameters are all optional, and can be used in combination to get the perfect voice for your usecase.

  • Parameters:
    • provider (string) - Try one of: google, polly, azure, msnr
    • providerFullName (string) - Try with one of: amazon polly, google, microsoft azure, aflorithmic labs
    • language (string) - Try with one of: english, spanish, french, german
    • accent (string) - Try with one of: american, british, neutral, portuguese/brazilian, american soft, mexican, australian
    • gender (string) - Try with one of: male, female
    • ageBracket (string) - Try with one of: adult, child, senior
    • tags (string) - Try with one or more (separated by commas) of: steady, confident, balanced, informative, serious, instructional, slow, storytelling, calm, clear, deep, formal, sad, thin, fast, upbeat, fun, energetic, tense, very fast, flat, low pitched, high pitched, low-pitched, sing-y, cooperative, kind, stable, monotonous, neutral, responsible, business man, straight to the point, knowledgeable, focused, newscastery, newsreader, interviewer, reliable, friendly, welcoming, good for handing out information, slightly friendly
    • industryExamples (string) - Try with one or more (separated by commas) of: fitness, business, commercial, fashion, travel, audiobook, real estate, faith, health industry, comercial, realestate, kids entertainment, games, customer service, education, storytelling, entertainment, kids, education audiobook
  • Example:

    all_voices = apiaudio.Voice.list()
    

  • Example:

    french_voices = apiaudio.Voice.list(language="french",tags="steady, fun")
    

• list_parameters() This endpoint lets you see which attributes you can filter the voices by, along with the allowed values for each attribute. You can later use these parameters and values to filter the voices you wish to list.

  • Parameters:

    • No parameters required.

  • Example:

    parameters = apiaudio.Voice.list_parameters()
    

Sound resource

Sound allows you to design your own sound template from a script and a background track. In order to get a sound template/project, make sure you requested speech for your script resource first.

Sound methods are:

• create() Creates a sound template, compresses the sound project into a zip file and returns the url.

  • Parameters:
    • scriptId * [Required] (string) - The script resource ID.
    • backgroundTrackId * [Required] (string) - The background track file ID.
  • Example:

    sound_url = apiaudio.Sound.create(
        scriptId="id-1234",
        backgroundTrackId="full__citynights.wav",
    )
    

• retrieve() Retrieve the url of the sound project zip file.

  • Parameters:
    • scriptId * [Required] (string) - The script resource ID.
  • Example:

    audio_files = apiaudio.Sound.retrieve(scriptId="id-1234")
    

• list() List all the available sound templates in our api. The parameters are all optional, and can be used in combination to get the perfect sound for your usecase.

  • Parameters:
    • industryExamples (string) - Try with one or more (separated by commas) of: news, travel, business, relaxation, fitness, relax, children stories
    • contents (string) - Try with one or more (separated by commas) of: intro, main, outro, effect1, effect2, main outro, droid_main, chewie_main, effect3, ambience, only effects
    • genre (string) - Try with one of: electronic, acoustic, atmospheric, abstract, rock
    • tempo (string) - Try with one of: mid, up, down, uptempo
    • tags (string) - Try with one or more (separated by commas) of: intense, minimal, reflective, melodic, happy, nostalgic, focus, energetic, uplifting, active, relaxed, ambience, mysterious, positive, informative, workout, work, meditation, travel, full silence
  • Example:

    sound_templates = apiaudio.Sound.list()
    

• list_parameters() This endpoint lets you see which attributes you can filter the sound templates by, along with the allowed values for each attribute. You can later use these parameters and values to filter the sound templates you wish to list.

  • Parameters:

    • No parameters required.

  • Example:

    parameters = apiaudio.Sound.list_parameters()
    

• download() Download the sound project zip file in your preferred folder.

  • Parameters:
    • scriptId * [Required] (string) - The script resource ID.
    • destination (string) - The folder destination path. Default is "." (current folder)
  • Example:

    audio_files = apiaudio.Sound.download(scriptId="id-1234", destination=".")
    

Mastering resource

Mastering allows you to create and retrieve a mastered audio file of your script. A mastered version contains the speech of the script, a background track, personalised parameters for your audience and a mastering process to enhance the audio quality of the whole track. In order to get a mastered audio file, make sure you requested speech for your script resource first.

Mastering methods are:

• create() Creates a mastered version of your script.
  • Parameters:
    • scriptId * [Required] (string) - The script resource ID.
    • backgroundTrackId (string) - The background track file ID. Deprecated, use soundTemplate parameter instead.
    • soundTemplate (string) - The sound template name. For the list of available sound templates check aflr.Sound.list_sound_templates() call.
    • audience (list) - List of dicts containing the personalisation parameters. This parameter depends on the number of parameters you used in your script resource. In the script documentation example above, we used 2 parameters: username and location, and in the following example below we want to produce the script for username Antonio with location Barcelona.
    • public (boolean) - Boolean flag that allows to store the mastered file in a public s3 folder. Default value is False. Warning - This will cause your mastered files to be public to anyone in the internet. Use this at your own risk.
    • vast (boolean) - Boolean flag that allows to create a VAST file of your mastered file. The vast flag only works if public is True. Default value is False.
  • Example:

    response = apiaudio.Mastering.create(
        scriptId="id-1234",
        backgroundTrackId="full__citynights.wav",
        audience=[{"username":"antonio", "location":"barcelona"}]
    )
    

• retrieve() Retrieves the mastered file urls.
  • Parameters:
    • scriptId * [Required] (string) - The script resource ID.
    • parameters (dict) - Dictionary containing the audience item you want to retrieve.
    • public (boolean) - Boolean flag that allows to retrieve the mastered file from the public bucket. Use this if you want to retrieve a mastered file created using public=True. Default value is False.
    • vast (boolean) - Boolean flag that allows to retrieve the VAST file of your mastered file. The vast flag only works if public is True. Default value is False.
  • Example:

    mastered_files = apiaudio.Mastering.retrieve(
      scriptId="id-1234",
      parameters={"username":"antonio", "location":"barcelona"}
    )
    

• download() Download the mastered files in your preferred folder.
  • Parameters:
    • scriptId * [Required] (string) - The script resource ID.
    • parameters (dict) - Dictionary containing the audience item you want to retrieve.
    • destination (string) - The folder destination path. Default is "." (current folder)
    • public (boolean) - Boolean flag that allows to retrieve the mastered file from the public bucket. Use this if you want to retrieve a mastered file created using public=True. Default value is False.
    • vast (boolean) - Boolean flag that allows to retrieve the VAST file of your mastered file. The vast flag only works if public is True. Default value is False.
  • Example:

    mastered_files = apiaudio.Mastering.download(
      scriptId="id-1234",
      parameters={"username":"antonio", "location":"barcelona"}
      destination="."
    )
    

File resource

File allows you to retrieve all the files available in api.audio for your organization.

Available soon.

SyncTTS resource

Warning: Please request access if you want to test this resource.

SyncTTS allows you to do Synchronous Text-To-Speech (TTS) with our API using all the voices available. Use it to create a speech audio file from a text and a voice name.

SyncTTS methods are:

• create() Create a TTS speech file.

  • Parameters:

    • voice * [Required] (string) - Voice id. See the list of available voices using Voice resource.
    • text * [Required] (string) - The text you want to do TTS with.

  • Example:

    sync_tts = apiaudio.SyncTTS.create(
      voice="salih",
      text="This is me creating synchronous text to speech"
    )
    

Authors

• https://github.com/tonythree
• https://github.com/GetOn4
• https://github.com/zeritte
• https://github.com/springcoil
• https://github.com/a96lex

License

This project is licensed under the terms of the MIT license.