Get audio project
get_audio_projectReturns an audio project's status and, once complete, its download URLs. Use to check progress with the id from an audio create tool. Read-only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Unique ID of the audio project. This value is returned by all of the POST APIs that create an audio. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Unique ID of the audio. Use it with the [Get audio Project API](https://docs.magichour.ai/api-reference/audio-projects/get-audio-details) to fetch status and downloads. | |
| name | Yes | The name of the audio. | |
| type | Yes | 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 | |
| error | Yes | In the case of an error, this object will contain the error encountered during video render | |
| status | Yes | 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. | |
| enabled | Yes | Whether this resource is active. If false, it is deleted. | |
| downloads | Yes | ||
| created_at | Yes | ||
| credits_charged | Yes | 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. |