Get a job given an Id.
GET/job/:id
Get a job given an Id.
Request
Path Parameters
Possible values: >= 3 characters
and <= 60 characters
Responses
- 2XX
Default Response
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
- Array [
- Array [
- Array [
- ]
- ]
- ]
- Array [
- Array [
- Array [
- ]
- ]
- ]
job object
Unique identifier of the stem generation job
Identifier of the client making the request
Timestamp of when the stem generation job was created
Timestamp of when the stem generation job was started
Timestamp of when the stem generation job was last updated
Unique identifier of the request that generated this stem generation job
Identifier of the license used for stem generation
metadata object
Possible values: [wav
, flac
, mp3
, aiff
]
Audio format of the stem
Name of the stem being generated
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)
Possible values: <= 1000 characters
Custom property of the stem
Flag indicating if the stem is or should generate a residual
Identifier of the user session making the request. Widget specific.
Identifier of the audio source used for stem generation. Widget specific.
Possible values: >= 20
The maximum length of the track in seconds. This is an optional property.
Set this flag to true to return a separate preview mp3 file. This is an optional property.
Possible values: >= 10
The interval for watermark in seconds. This is an optional property.
stemMetadata object
Possible values: [wav
, flac
, mp3
, aiff
]
Audio format of the stem
Name of the stem being generated
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)
Possible values: <= 1000 characters
Custom property of the stem
Flag indicating if the stem is or should generate a residual
Identifier of the user session making the request. Widget specific.
Identifier of the audio source used for stem generation. Widget specific.
Possible values: >= 20
The maximum length of the track in seconds. This is an optional property.
Set this flag to true to return a separate preview mp3 file. This is an optional property.
Possible values: >= 10
The interval for watermark in seconds. This is an optional property.
URL for the callback function to receive updates on the stem generation job
Current status of the stem generation job
statusInfo objectnullable
Code indicating the status of the stem generation job
Message providing additional information on the status of the stem generation job
sourceAsset objectnullable
Asset representing the source audio used for stem generation
Name of the asset
Unique identifier of the asset
Type of the file of the asset
Format of the asset
URL link of the asset
jobs object[]
Array of jobs containing the stem assets generated from the asset
stemAssets object[]
Array of stem assets generated for the job
Name of the stem asset
Unique identifier of the stem asset
Type of the file of the stem asset
Format of the stem asset
Path of the stem asset
stemAssets object[]
Array of assets representing the generated stems
Name of the asset
Unique identifier of the asset
Type of the file of the asset
Format of the asset
URL link of the asset
jobs object[]
Array of jobs containing the stem assets generated from the asset
stemAssets object[]
Array of stem assets generated for the job
Name of the stem asset
Unique identifier of the stem asset
Type of the file of the stem asset
Format of the stem asset
Path of the stem asset
outputAssets object[]
Array of assets representing the generated stems
Name of the asset
Unique identifier of the asset
Type of the file of the asset
Format of the asset
URL link of the asset
jobs object[]
Array of jobs containing the stem assets generated from the asset
stemAssets object[]
Array of stem assets generated for the job
Name of the stem asset
Unique identifier of the stem asset
Type of the file of the stem asset
Format of the stem asset
Path of the stem asset
{
"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"
}
]
}
]
}
]
}
}