BRbraiv
Music

Get a music generation

Returns status for a generation created by the caller. audioUrl is a one-hour signed URL when status is ready. Required scope: music:write.

get/music/{musicId}

Request

  • Base URL
    https://api.braiv.co/v1
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

musicIdstring required

Music generation id returned by createMusic.

Response

Generation status. Ready responses include a signed audio URL.

musicIdstring required

Music generation id.

jobIdstring required

Pollable job id, music_{musicId}.

status'queued' | 'processing' | 'ready' | 'failed' required

Normalized lifecycle shared by jobs and video projections: queued is waiting to start, processing is running, ready completed successfully, and failed reached a terminal error.

promptstring required

Prompt used for this generation.

durationnumber required

Requested length in seconds.

creditsSpentinteger required

Credits debited up front.

audioUrlstring nullable required

One-hour signed URL for the mp3 when status is ready.

errorstring nullable required

Failure message when status is failed.

Changes

No recorded changes to this operation across all 1 revision of this API.