Documentation
Developers / Sound Cleaning
Delete a finished sound cleaning job and its audio
https://api.echonova.ai/v1/sound-cleaning/jobs/{jobId}Deletes a finished API job of this key's workspace, with its original and cleaned files, whichever key created it. A job of another workspace answers 404. Needs Sound Cleaning access on the key.
Headers
Bearer, a space, then your API key, which starts with ek_. Create keys in the portal under Developers, API Keys.
Path parameters
The jobId the API returned when the job was created.
Response
200 application/json Every response uses this envelope.
The result.
true once the job is deleted.
true for a successful call.
Repeats the HTTP status.
null on success.
Errors
Same envelope, with success false and data null. All errors
When. jobId is not a 24-character hexadecimal id.
Fix. Use the id exactly as the create call returned it.
When. The job is pending or processing; only a completed or failed job can be deleted.
Fix. Wait until the job has finished, then delete it.
When. The Authorization header is missing or is not Bearer ek_..., no key matches the token, or the key is deleted, disabled or its account is closed.
Fix. Send Authorization: Bearer ek_... with an enabled key from this environment.
When. The workspace that owns the key has no subscription.
Fix. Check the workspace's plan in the portal.
When. The subscription is in a state other than active or trial.
Fix. Renew the subscription.
When. The key is restricted and Sound Cleaning is not among its services.
Fix. Edit the key and turn Sound Cleaning on, or use another key.
When. The job id is unknown, or the job belongs to another workspace or was made in the portal.
Fix. Use a jobId from this workspace's API jobs.
When. The key made more than 100 requests to one endpoint in 60 seconds, or one IP address made more than 100 requests to one endpoint in 60 seconds (the IP limit is counted before the key is checked, so it can answer with no key at all); a Retry-After header carries the seconds to wait.
Fix. Wait Retry-After seconds, then retry.
When. An error the API did not classify.
Fix. Check the request, then retry after a short wait; contact support if it persists.
When. The job's stored audio could not be removed; the job is kept.
Fix. Retry the delete after a short wait.
When. A transient outage inside the API.
Fix. Retry after a short wait.
When. A transient timeout inside the API.
Fix. Retry after a short wait.
curl -X DELETE "https://api.echonova.ai/v1/sound-cleaning/jobs/{jobId}" \
-H "Authorization: Bearer YOUR_API_KEY"{
"data": {
"deleted": true
},
"success": true,
"statusCode": 200,
"errorMessage": null
}