music

Generate music from a reference audio

post/v1/music/reference-audio-to-music

Request

  • Base URL: https://api.beatra.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.beatra.ai/v1/music/reference-audio-to-music
  • Auth: none declared. Required headers: Idempotency-Key

Headers

x-request-idstring nullable
Idempotency-Keystring required
authorizationstring nullable

Request body

metadataobject nullable

Caller-supplied metadata; limited by task creation policy.

callback_urlstring nullable

HTTPS URL beatra will POST the final Task envelope to when the Task reaches a terminal state

callback_signing_key_idstring nullable

Optional standalone callback signing key. Omit for unsigned callback delivery; requires callback_url when provided.

model'auto' | 'minimax-music-3.0' | 'suno-6' required
promptstring required

Style, mood, genre, and instrumentation. When lyrics are supplied (or Suno custom mode is on) this maps to the provider's style-conditioning field; otherwise it is the song description the model writes the song from. Either way it is not an instruction field: execution directives written here (for example "do not omit anything", "sing it verbatim", "make chapter three differ from chapter one") are not read as instructions and will not be obeyed. Put the words to be sung in lyrics, or set instrumental to true for a track with no vocals.

lyricsstring nullable

Optional lyrics text. Must be omitted for instrumental music.

instrumentalboolean

When true, generate instrumental music without vocals.

titlestring nullable

Response

Task accepted

object'task'
task_idstring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
capabilitystring required
workload_type'model' | 'social_operation'
modelstring nullable

Caller-requested model verbatim (may be 'auto'). Null for social_operation tasks.

resolved_modelstring nullable

Actual model that ran (null until execution starts; equals model for explicit-model calls)

model_selection_reasonunknown
metadataobject nullable
inputobject nullable
outputobject nullable
created_atstring date-time required
started_atstring date-time nullable
deadline_atstring date-time nullable
completed_atstring date-time nullable
cancel_requested_atstring date-time nullable

Changes

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