Start building
SandBase

Appearance

ElevenLabs Music v2.5

POST/v1/run

ElevenLabs Music v2.5 generates studio-quality songs and instrumentals with vocals from a text prompt, up to 10 minutes long.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to elevenlabs/music/2.5.

Default: elevenlabs/music/2.5

stringpromptrequired

The text prompt describing the music to generate

Optional<boolean>force_instrumental

If true, guarantees that the generated song will be instrumental.

Default: false

Optional<integer>music_length_ms

The length of the song to generate in milliseconds (3000-600000). If not provided, the model will choose a length based on the prompt.

Range: 3000 to 600000

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: text-to-music

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async