MAmagichourhq
Audio Projects

Get audio details

Changed on

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}

Request

  • Base URL
    https://api.magichour.ai
  • URL
    https://api.magichour.ai/v1/audio-projects/{id}
  • Auth
    HTTP bearer

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.

status'draft' | 'queued' | 'rendering' | 'complete' | 'error' | 'canceled' required

The status of the audio.

  • draft - the project was created but has not been submitted for rendering
  • queued - the job is waiting for an available server
  • rendering - the job is being processed; the audio.started webhook event fires when rendering begins
  • complete - the job finished successfully; fires audio.completed
  • error - the job failed during processing; fires audio.errored
  • canceled - the job was manually canceled (for example from the Magic Hour web app)

Note: rendering, complete, and error have matching webhook events; canceled does not - a canceled job emits no webhook event, so poll this endpoint to detect cancellation.

typestring required

The type of the audio project. Possible values are AUDIO_TRANSLATOR, VOICE_GENERATOR, VOICE_CHANGER, VOICE_CLONER, VIDEO_TO_AUDIO, MUSIC_GENERATOR, SOUND_EFFECT_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"
  }
}

Changes

  • 9aeb9397c62aRevision changes
    • info

      added the non-success response with the status

    • info

      removed the Not Found enum value from the response property for the response status

    • info

      removed the Unauthorized enum value from the response property for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 1f72d520ddc6Revision changes
    • info

      added the non-success response with the status