Create a new job.

POST 
/job/

Create a new job.

Request

application/json

Body

oneOf

MOD1

callbackUrl urirequired

Possible values: >= 4 characters

The callback URL for job status notifications. Must be a valid URI with a minimum length of 4 characters.

assetId stringrequired

Possible values: >= 8 characters and <= 30 characters

A unique identifier for the asset. Must be a string with a minimum length of 8 characters and a maximum length of 30 characters.

metadata

object

required

oneOf

MOD1

format string

Possible values: [wav, flac, mp3, aiff, mp4]

The audio file format. Allowed values: wav, flac, mp3, aiff, mp4.

name string

Possible values: [transcription, alignment, instrumental, vocals, drums, bass, other, guitar, other-x-guitar, wind, speech, music, dialogue, piano, music_fx, music_removal]

The stem you want to generate.

otherAssets array

customProperty string

Possible values: <= 1000 characters

A custom string for client use or debugging. Maximum length: 1000 characters. This is an optional property.

residual boolean

Set this flag to true to return a separate residual file. This is an optional property.

userSessionId string

Represents the user session ID associated with this job.

audioId string

Represents the custom unique audio file ID associated with this job.

licenseId string

The license ID associated with this job.

maxTrackLength number

Possible values: >= 20

The maximum length of the track in seconds. This is an optional property.

preview boolean

Set this flag to true to return a separate preview mp3 file. This is an optional property.

watermarkInterval number

Possible values: >= 10

The interval for watermark in seconds. This is an optional property.

MOD2

format string

Possible values: [json, txt, srt, all]

The output transcript format. Allowed values: json, txt, srt, all.

name string

Possible values: [transcription, alignment]

The stem you want to generate.

language string

Possible values: Value must match regular expression ^[a-zA-Z]{2}$, [af, ar, az, be, bg, bs, ca, cs, cy, da, de, el, en, es, et, fa, fi, fr, gl, he, hi, hr, hu, hy, id, is, it, ja, kk, kn, ko, lt, lv, mi, mk, mr, ms, ne, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, sw, ta, th, tl, tr, uk, ur, vi, zh, auto]

The language model to use for alignment (Default is auto)

translationLanguage string

Possible values: Value must match regular expression ^[a-zA-Z]{2}$, [af, ar, az, be, bg, bs, ca, cs, cy, da, de, el, en, es, et, fa, fi, fr, gl, he, hi, hr, hu, hy, id, is, it, ja, kk, kn, ko, lt, lv, mi, mk, mr, ms, ne, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, sw, ta, th, tl, tr, uk, ur, vi, zh]

The language for lyrics translation

otherAssets array

customProperty string

Possible values: <= 1000 characters

Pass any custom string for clients use or debugging. max 1000 chars. optional property

userSessionId string

Represents the userSessionId associated with this job

audioId string

Represents the custom unique audio file id associated with this job

licenseId string

maxTrackLength number

Possible values: >= 20

The maximum length of the track in seconds. This is an optional property.

preview boolean

Set this flag to true to return a separate preview mp3 file. This is an optional property.

watermarkInterval number

Possible values: >= 10

The interval for watermark in seconds. This is an optional property.

otherSourceAssets

object[]

Array [

id stringrequired

type stringrequired

Possible values: [transcription]

name string

]

MOD2

stemMetadata

object

required

format stringrequired

Possible values: [wav, flac, mp3, aiff, mp4]

The audio file format. Allowed values: wav, flac, mp3, aiff, mp4.

stemName stringrequired

Possible values: [transcription, alignment, instrumental, vocals, drums, bass, other, guitar, other-x-guitar, wind, speech, music, dialogue, piano, music_fx, music_removal]

The stem you want to generate.

customProperty string

Possible values: <= 1000 characters

A custom string for client use or debugging. Maximum length: 1000 characters. This is an optional property.

residual boolean

Set this flag to true to return a separate residual file. This is an optional property.

userSessionId string

Represents the user session ID associated with this job.

audioId string

Represents the custom unique audio file ID associated with this job.

licenseId string

The license ID associated with this job.

maxTrackLength number

Possible values: >= 20

The maximum length of the track in seconds. This is an optional property.

preview boolean

Set this flag to true to return a separate preview mp3 file. This is an optional property.

watermarkInterval number

Possible values: >= 10

The interval for watermark in seconds. This is an optional property.

callbackUrl urirequired

Possible values: >= 4 characters

The callback URL for job status notifications. Must be a valid URI with a minimum length of 4 characters.

assetId stringrequired

Possible values: >= 8 characters and <= 30 characters

A unique identifier for the asset. Must be a string with a minimum length of 8 characters and a maximum length of 30 characters.

Responses

2XX

Default Response

application/json

Schema

Schema

job

object

id string

Unique identifier of the stem generation job

clientId string

Identifier of the client making the request

createdAt string

Timestamp of when the stem generation job was created

startedAt string

Timestamp of when the stem generation job was started

updatedAt string

Timestamp of when the stem generation job was last updated

requestId string

Unique identifier of the request that generated this stem generation job

licenseId string

Identifier of the license used for stem generation

metadata

object

format string

Possible values: [wav, flac, mp3, aiff, mp4]

Audio format of the stem

name string

Name of the stem being generated

language string

Possible values: Value must match regular expression ^[a-zA-Z]{2}$, [af, ar, az, be, bg, bs, ca, cs, cy, da, de, el, en, es, et, fa, fi, fr, gl, he, hi, hr, hu, hy, id, is, it, ja, kk, kn, ko, lt, lv, mi, mk, mr, ms, ne, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, sw, ta, th, tl, tr, uk, ur, vi, zh, auto]

The language model to use for alignment (Default is auto)

customProperty string

Possible values: <= 1000 characters

Custom property of the stem

residual boolean

Flag indicating if the stem is or should generate a residual

userSessionId string

Identifier of the user session making the request. Widget specific.

audioId string

Identifier of the audio source used for stem generation. Widget specific.

maxTrackLength number

Possible values: >= 20

The maximum length of the track in seconds. This is an optional property.

preview boolean

Set this flag to true to return a separate preview mp3 file. This is an optional property.

watermarkInterval number

Possible values: >= 10

The interval for watermark in seconds. This is an optional property.

stemMetadata

object

format string

Possible values: [wav, flac, mp3, aiff, mp4]

Audio format of the stem

stemName string

Name of the stem being generated

language string

Possible values: Value must match regular expression ^[a-zA-Z]{2}$, [af, ar, az, be, bg, bs, ca, cs, cy, da, de, el, en, es, et, fa, fi, fr, gl, he, hi, hr, hu, hy, id, is, it, ja, kk, kn, ko, lt, lv, mi, mk, mr, ms, ne, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, sw, ta, th, tl, tr, uk, ur, vi, zh, auto]

The language model to use for alignment (Default is auto)

customProperty string

Possible values: <= 1000 characters

Custom property of the stem

residual boolean

Flag indicating if the stem is or should generate a residual

userSessionId string

Identifier of the user session making the request. Widget specific.

audioId string

Identifier of the audio source used for stem generation. Widget specific.

maxTrackLength number

Possible values: >= 20

The maximum length of the track in seconds. This is an optional property.

preview boolean

Set this flag to true to return a separate preview mp3 file. This is an optional property.

watermarkInterval number

Possible values: >= 10

The interval for watermark in seconds. This is an optional property.

callbackUrl string

URL for the callback function to receive updates on the stem generation job

status string

Current status of the stem generation job

statusInfo

null,object

code number

Code indicating the status of the stem generation job

message string

Message providing additional information on the status of the stem generation job

duration number

duration of the asset processed

sourceAsset

null,object

Asset representing the source audio used for stem generation

name string

Name of the asset

id string

Unique identifier of the asset

fileType string

Type of the file of the asset

format string

Format of the asset

link string

URL link of the asset

jobs

object[]

Array of jobs containing the stem assets generated from the asset

Array [

stemAssets

object[]

Array of stem assets generated for the job

Array [

name string

Name of the stem asset

id string

Unique identifier of the stem asset

fileType string

Type of the file of the stem asset

format string

Format of the stem asset

path string

Path of the stem asset

]

]

stemAssets

object[]

Array of assets representing the generated stems

Array [

name string

Name of the asset

id string

Unique identifier of the asset

fileType string

Type of the file of the asset

format string

Format of the asset

link string

URL link of the asset

jobs

object[]

Array of jobs containing the stem assets generated from the asset

Array [

stemAssets

object[]

Array of stem assets generated for the job

Array [

name string

Name of the stem asset

id string

Unique identifier of the stem asset

fileType string

Type of the file of the stem asset

format string

Format of the stem asset

path string

Path of the stem asset

]

]

]

outputAssets

object[]

Array of assets representing the generated stems

Array [

name string

Name of the asset

id string

Unique identifier of the asset

fileType string

Type of the file of the asset

format string

Format of the asset

link string

URL link of the asset

jobs

object[]

Array of jobs containing the stem assets generated from the asset

Array [

stemAssets

object[]

Array of stem assets generated for the job

Array [

name string

Name of the stem asset

id string

Unique identifier of the stem asset

fileType string

Type of the file of the stem asset

format string

Format of the stem asset

path string

Path of the stem asset

]

]

]

Example (from schema)

{
  "job": {
    "id": "string",
    "clientId": "string",
    "createdAt": "string",
    "startedAt": "string",
    "updatedAt": "string",
    "requestId": "string",
    "licenseId": "string",
    "metadata": {
      "format": "wav",
      "name": "string",
      "language": "af",
      "customProperty": "string",
      "residual": true,
      "userSessionId": "string",
      "audioId": "string",
      "maxTrackLength": 0,
      "preview": true,
      "watermarkInterval": 0
    },
    "stemMetadata": {
      "format": "wav",
      "stemName": "string",
      "language": "af",
      "customProperty": "string",
      "residual": true,
      "userSessionId": "string",
      "audioId": "string",
      "maxTrackLength": 0,
      "preview": true,
      "watermarkInterval": 0
    },
    "callbackUrl": "string",
    "status": "string",
    "stemAssets": [
      {
        "name": "string",
        "id": "string",
        "fileType": "string",
        "format": "string",
        "link": "string",
        "jobs": [
          {
            "stemAssets": [
              {
                "name": "string",
                "id": "string",
                "fileType": "string",
                "format": "string",
                "path": "string"
              }
            ]
          }
        ]
      }
    ],
    "outputAssets": [
      {
        "name": "string",
        "id": "string",
        "fileType": "string",
        "format": "string",
        "link": "string",
        "jobs": [
          {
            "stemAssets": [
              {
                "name": "string",
                "id": "string",
                "fileType": "string",
                "format": "string",
                "path": "string"
              }
            ]
          }
        ]
      }
    ]
  }
}

Loading...