Get a job given an Id.

GET 
/job/:id

Get a job given an Id.

Request

Path Parameters

id stringrequired

Possible values: >= 3 characters and <= 60 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]
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]
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 objectnullable
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
sourceAsset objectnullable
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",
    "statusInfo": {
      "code": 0,
      "message": "string"
    },
    "sourceAsset": {
      "name": "string",
      "id": "string",
      "fileType": "string",
      "format": "string",
      "link": "string",
      "jobs": [
        {
          "stemAssets": [
            {
              "name": "string",
              "id": "string",
              "fileType": "string",
              "format": "string",
              "path": "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...