Skip to main content
Version: 1.1.0

Authentication

All API requests must be authenticated using an API key.

Issue API Keys​

You can generate API keys in the dashboard under API Keys. Each project is issued a unique API key.

Caution
Never expose your API key in publicly accessible environments (e.g., GitHub, client-side code).

Required request headers​

Include the following HTTP header in every API call:

Header nameRequiredDescription
x-ga-apikeyYesYour issued API key

Authentication examples​

Include the API key in the request header.

curl --request GET \
  --url https://restapi.gaudiolab.io/developers/api/v1/gsep_music_hq_v1/jobs/{JOB_ID} \
  --header 'x-ga-apikey: {API_KEY}'

Other HTTP method examples:

# POST request example
curl --request POST \
  --url https://restapi.gaudiolab.io/developers/api/v1/gsep_music_hq_v1/jobs \
  --header 'x-ga-apikey: {API_KEY}' \
  --header 'Content-Type: application/json' \
  --data '{"audioUploadId": "{UPLOAD_ID}", "type": "vocal,drum"}'

API usage is tracked on a per-project basis identified by the API key.