overview

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

The Tasks API replaces the legacy Jobs API. This page covers the key structural differences and maps every legacy concept to its equivalent so you can migrate your integration. For a full reference of the legacy API, see the Legacy API Reference.

The most important difference

In the legacy API, one job processes one model. If you needed vocals, instrumental, and drums, you submitted three separate jobs. In the Tasks API, one task can process multiple models. You submit one request with a targets array — each target specifying a model and output format — and all outputs are produced together.

Legacy — 3 separate jobs

Tasks API — 1 task

# Job 1: vocals
curl -X POST "https://groovy.audioshake.ai/job" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{ "metadata": { "name": "vocals", "format": "wav" }, "assetId": "<id>" }'

# Job 2: instrumental
curl -X POST "https://groovy.audioshake.ai/job" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{ "metadata": { "name": "instrumental", "format": "wav" }, "assetId": "<id>" }'

# Job 3: drums
curl -X POST "https://groovy.audioshake.ai/job" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{ "metadata": { "name": "drums", "format": "wav" }, "assetId": "<id>" }'

curl -X POST "https://api.audioshake.ai/tasks" \
  -H "x-api-key: $AUDIOSHAKE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "assetId": "<id>",
    "targets": [\
      { "model": "vocals", "formats": ["wav"] },\
      { "model": "instrumental", "formats": ["wav"] },\
      { "model": "drums", "formats": ["wav"] }\
    ]
  }'

Concept mapping

Request body structure

The job request body uses a metadata object to specify the model and format. The Tasks API flattens this into a targets array.

Legacy job body

Tasks API body

{
  "metadata": {
    "name": "vocals",
    "format": "wav"
  },
  "assetId": "<asset-id>",
  "callbackUrl": "https://your-app.com/webhooks"
}

{
  "assetId": "<asset-id>",
  "targets": [\
    { "model": "vocals", "formats": ["wav"] }\
  ]
}

Authentication

Legacy

Tasks API

curl -X GET "https://groovy.audioshake.ai/job/<id>" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

curl -X GET "https://api.audioshake.ai/tasks/<id>" \
  -H "x-api-key: $AUDIOSHAKE_API_KEY"

Generate your Tasks API key in Settings → API Keys — no need to contact support.

Uploading a file

The endpoint path and field names are the same. Only the auth header changes.

Legacy

Tasks API

curl -X POST "https://groovy.audioshake.ai/upload" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: multipart/form-data" \
  -F 'file=@song.mp3;type=audio/mpeg'

curl -X POST "https://api.audioshake.ai/assets" \
  -H "x-api-key: $AUDIOSHAKE_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F 'file=@song.mp3;type=audio/mp3'

Both return an object with an id field. Use that as assetId in your processing request.

Webhooks

In the legacy API, you passed callbackUrl inside each job request. In the Tasks API, register your endpoint once — all task completion events are then delivered automatically.

curl -X POST "https://api.audioshake.ai/webhooks" \
  -H "x-api-key: $AUDIOSHAKE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/webhooks"
  }'

See Using Webhooks for full setup details.

Migration checklist

1. Generate a Tasks API key Go to Settings → API Keys and create a new key.
2. Update your base URL Replace https://groovy.audioshake.ai with https://api.audioshake.ai.
3. Update authentication Replace Authorization: Bearer TOKEN with x-api-key: YOUR_KEY.
4. Update file upload Replace POST /upload with POST /assets. The response id field is the same — use it as assetId.
5. Consolidate jobs into one task Replace each group of per-model job requests with a single POST /tasks request. Move each metadata.name into a target’s model field, and each metadata.format into formats (as an array).
6. Register webhooks separately If you used callbackUrl, register your endpoint once via POST /webhooks and remove callbackUrl from your task requests.
7. Update response handling The legacy response wraps the job in a { "job": { ... } } envelope. The Tasks API response is a flat object — update any code that reads response.job.id to read response.id instead.
8. Update status polling Replace GET /job/<id> with GET /tasks/<id>. Output download links are in the targets[].outputAssets array.

Questions?

Contact support@audioshake.ai if you run into issues during migration.