API Reference

🔑 Authentication

All requests must be made over HTTPS and will be authenticated using an API key. To create your first API Key, please use the AudioStack Platform.

🚧

Keep your API keys secret!

They should not be added to the client-side code or checked into your application's code, including through repositories such as Github.

import audiostack
import os
 
audiostack.api_key = os.environ["AUDIO_STACK_DEV_KEY"]

Code Examples

Get your first audio project started with the below example. This is also useful for debugging if your API key is working.

Create a script

This creates a project called myFirstAudioProject with one module admodule under which you'll find your first script.

curl -X 'POST' \
  'https://v2.api.audio/content/script' \
  -H 'accept: application/json' \
  -H 'x-api-key: APIKEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "projectName": "myFirstAudioProject",
  "moduleName": "admodule",
  "scriptName": "script1",
  "scriptText": "Got my first script created!"
}'

Retrieve uploaded custom audio files

curl --request GET \
     --url 'https://v2.api.audio/content/media' \
     --header 'Accept: application/json' \
     --header 'x-api-key: APIKEY'