Skip to main content
GET
Retrieve a music job

Authorizations

Authorization
string
header
required

Your Deepshi API key, sent as Authorization: Bearer <key>.

Path Parameters

audio_id
string
required

The job id returned by POST /v1/audio/generations.

Response

The music job.

A music generation job.

id
string

The job id. Pass it to the retrieve and content endpoints.

object
string

Object type, always audio.

Example:

"audio"

model
string

The music model id you requested.

status
enum<string>

Lifecycle state of the job.

Available options:
in_progress,
completed,
failed
seconds
string

Length of the generated track in seconds, present when status is completed.

created_at
integer<int64>

Unix timestamp when the job was created.

completed_at
integer<int64> | null

Unix timestamp when the job completed.

audio
object[]

The generated song, present when status is completed.

error
object | null

Present when status is failed. Explains the failure; the job is not charged.