v47

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01360485.4 KB

Audio Projects

Get audio details

Check the progress of a audio project. The downloads field is populated after a successful render.

Statuses

queued — waiting to start
rendering — in progress
complete — ready; see downloads
error — a failure occurred (see error)
canceled — user canceled
draft — not used

get/v1/audio-projects/{id}

Path parameters

idstring required

Example:cuid-example

Unique ID of the audio project. This value is returned by all of the POST APIs that create an audio.

Response

Success

idstring required

Unique ID of the audio. Use it with the Get audio Project API to fetch status and downloads.

namestring nullable required

The name of the audio.

The status of the audio.

typestring required

The type of the audio project. Possible values are VOICE_GENERATOR, VOICE_CHANGER, VOICE_CLONER, VIDEO_TO_AUDIO, MUSIC_GENERATOR

created_atstring date-time required

enabledboolean required

Whether this resource is active. If false, it is deleted.

credits_chargedinteger required

The amount of credits deducted from your account to generate the audio. We charge credits right when the request is made.

If an error occurred while generating the audio, credits will be refunded and this field will be updated to include the refund.

Example response

{
  "id": "cuid-example",
  "name": "Example Name",
  "status": "complete",
  "type": "VOICE_GENERATOR",
  "credits_charged": 2,
  "downloads": [
    {
      "url": "https://videos.magichour.ai/id/output.wav",
      "expires_at": "2024-10-19T05:16:19.027Z"
    }
  ],
  "error": {
    "message": "Please use an image with a detectable face",
    "code": "no_source_face"
  }
}