GET
/
audio-separation
/
{task_id}
curl --request GET \
  --url https://client.camb.ai/apis/audio-separation/{task_id} \
  --header 'x-api-key: <api-key>'
"SUCCESS"

When you submit an audio file for separation into its component tracks, our system begins processing your request as a background task. This endpoint serves as your window into that process, allowing you to monitor the progression of your audio separation task from initiation to completion.

​
Making Status Requests

To check on your audio separation task’s progress, you’ll need the unique task_id that was provided when you initially submitted your separation request. With this identifier, simply make a GET request to the endpoint:

GET https://client.camb.ai/apis/audio-separation/{task_id}

​
Troubleshooting Common Issues

If you encounter difficulties while checking separation status, consider these common solutions:

  1. Invalid Task ID: Verify the task ID was correctly stored and passed to the status endpoint. Task IDs are case-sensitive and must be used exactly as provided.

  2. Authentication Problems: Ensure your API key is valid and correctly included in the request headers.

  3. Network Connectivity: Implement proper error handling for network issues that might interrupt status checking, including automatic retry logic.

  4. Unexpected Terminal States: If a separation ends with an error status, examine the error message for specific issues that might be addressed in subsequent separation attempts.

By properly integrating status checking into your application, you can create a seamless separation experience that keeps your users informed throughout the entire process, building confidence in your service and ensuring timely delivery.

Authorizations

​
x-api-key
string
header
required

The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.

Path Parameters

​
task_id
string
required

This parameter represents a unique identifier for a task. It is used in various API endpoints to query the status or result of a specific task. The task_id is typically returned when a task is created.

Response

200
application/json

Successful Response

The response is of type enum<string>.

Available options:
SUCCESS,
PENDING,
TIMEOUT,
ERROR,
PAYMENT_REQUIRED