Sign in
Clean Audio

Get a clean audio job

Retrieve the current state of a clean audio job by its job_id.

The response uses the shared job envelope, whose status is one of:

  • PROCESSING — still cleaning; the result is empty
  • COMPLETED — done; the result holds the denoised audio
  • FAILED — the job was accepted but processing failed; the error holds a failure code

Poll this endpoint until the status is COMPLETED or FAILED. An unknown job_id returns 404 Not Found.

Failure codes

CodeMeaning
input_validationAn input is missing or invalid. error.details names the input at fault when there is one.
content_moderationAn input breaks the content rules. Only send images, video and voices you own or have permission to use.
invalid_fileA file could not be read. Check its format, and that it is not corrupted.
audio_too_longThe audio is longer than the model accepts. Shorten it, or split it across jobs.
transload_failedA file could not be downloaded from its URL. Make sure the URL is public and works without a login.
generation_failedThe model failed while rendering. Retry; if it keeps failing, contact support with the job_id.
timeoutThe job ran out of time. Retry; if it keeps failing, contact support with the job_id.
insufficient_creditsThe balance ran out before the job could be paid for. Top up in the dashboard's Billing, then retry.
get/v1/clean-audio/{job_id}

Path parameters

job_idstring uuid required

Identifier of the clean audio job, returned when the job was submitted.

Example:123e4567-e89b-12d3-a456-426614174000

Identifier of the clean audio job, returned when the job was submitted.

Headers

X-Veed-Store-IO'0' | '1'

Set to 0 to not store this request's and response's bodies. They are then not available in your request logs for debugging.

X-Veed-Media-Expiration-Secondsinteger

Number of seconds before the media URLs returned for this request expire. A value above the maximum is capped rather than rejected.

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

Example response

{
  "$schema": "https://api.veed.io/schemas/ResourceCleanAudioJob.json",
  "data": {
    "result": {
      "audio": {
        "content_type": "video/mp4"
      }
    }
  }
}

Changes

Changed in 2 of the 4 revisions of this API.11