Create a separation job

posthttps://api.netflix.developers.gaudiolab.io/v1/jobs

Submits one asset for separation. List the tracks you want in targets — for example dme_dialogue_v1, dme_music_v1, karaoke_vocal_v1, and stem_bass_v1 in one request. Each target is processed independently and may finish at a different time. The job returns immediately with a jobId; results arrive via webhook or polling.

post/jobs

curl -X POST "https://api.netflix.developers.gaudiolab.io/v1/jobs" \
  -H "x-api-key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "assetId": "as_7f3a9c",
    "targets": [
      {
        "model": "dme_dialogue_v1",
        "tier": "premium",
        "formats": [
          "wav"
        ]
      }
    ],
    "webhookUrl": "https://..."
  }'

Response202

{
  "jobId": "job_91b2e0",
  "status": "queued",
  "targets": [
    {
      "model": "dme_dialogue_v1",
      "tier": "premium",
      "status": "queued"
    },
    {
      "model": "karaoke_vocal_v1",
      "status": "queued"
    },
    {
      "model": "stem_bass_v1",
      "status": "queued"
    }
  ]
}

Headers

x-api-keyRequired

Your project API key, sent on every request. Create and manage keys in the dashboard under Settings → API Keys.

Idempotency-KeystringOptional

A unique key you generate to safely retry this request. If a job was already created with the same key, the original job is returned instead of creating a duplicate.

Request body

assetIdstringRequired

Identifier of a ready asset to process.

targetsTargetRequest[]Required

The separation outputs to produce. Each target runs independently and can complete at a different time.

modelstringRequired

Model alias to run. Examples: dme_dialogue_v1 for DME, stem_vocal_v1 for multi-stem separation, or karaoke_vocal_v1 for instrumental-track separation. See GET /models.

tierenumOptional

Processing tier for DME separation only. Supported values depend on the selected model; check the model's tiers list in GET /models. Non-DME models reject tier. A tier can also narrow what the model accepts — see tier_overrides in GET /models.

Allowed values: premiumstandardlive

formatsenum[]Required

Formats to render this output in. Each format is returned as a separate downloadable file.

webhookUrlstring (uri)Optional

HTTPS endpoint that receives a POST as each target completes. If omitted, poll GET /jobs/{jobId} for results instead.

Response

202The job was accepted and processing has started.

jobIdstringRequired

Unique identifier for the job.

statusenumRequired

Aggregate status across all targets. completed once every target has finished — note an individual target may still have failed.

Allowed values: queuedprocessingcompletedfailed

progressintegerOptional

Overall completion percentage, a rollup across all targets. Only reaches 100 once the job is terminal (completed or failed).

linksExpireAtstring (date-time)Optional

ISO 8601 timestamp when the download links stop working. Re-fetch the job to refresh them. Links are valid for 48 hours.

targetsTargetResult[]Required

Per-target results, in the order they were requested.

modelstringRequired

The model alias this result corresponds to.

tierenumOptional

The processing tier this target was processed with. Present for DME targets only.

Allowed values: premiumstandardlive

statusenumRequired

Status of this individual target.

Allowed values: queuedprocessingcompletedfailed

progressintegerOptional

Completion percentage for this target. A completed target reports 100.

outputmap<string, map<string, string (uri)>>Optional

Download links, keyed by stem name and then by format (for example output.dialogue.wav). Present once status is completed.

errorTargetErrorOptional

Failure details. Present only when status is failed.

codeenumRequired

A stable, machine-readable code. New codes may be added over time — treat an unrecognised one as a generic failure and fall back to retryable.

Allowed values: PROCESSING_FAILEDPROCESSING_TIMEOUTQUEUE_TIMEOUTSOURCE_EXPIREDJOB_CANCELLED

messagestringRequired

A human-readable explanation. Fixed per code — safe to show to an end user, but do not parse it or branch on its wording.

retryablebooleanRequired

Whether resubmitting the same source can succeed. true means the failure was transient (an interrupted run, a timeout, or no capacity in time) — retry with backoff. false means retrying changes nothing.

400The request was malformed or failed validation.

codestringRequired

A stable, machine-readable error code you can branch on.

messagestringRequired

A human-readable explanation of what went wrong.

401The API key is missing or invalid.

codestringRequired

A stable, machine-readable error code you can branch on.

messagestringRequired

A human-readable explanation of what went wrong.

404The assetId does not exist or has expired.

codestringRequired

A stable, machine-readable error code you can branch on.

messagestringRequired

A human-readable explanation of what went wrong.

422The asset's channel layout is not supported for the requested targets (UNSUPPORTED_CHANNELS). Returned when the input is neither mono, stereo, nor an authoritative 5.1 PCM WAV/RF64, or when a 5.1 input is sent to a target that does not accept 5.1.

codestringRequired

A stable, machine-readable error code you can branch on.

messagestringRequired

A human-readable explanation of what went wrong.