Skip to main content
POST
cURL

Continue building

Arrange background audio

Upload files and place them on tracks.

Create an instance

Place a ready file on a track.

Studio CLI

Run the same operations from a terminal.

Authorizations

xi-api-key
string
header
required

Breeze Developer API key.

Body

application/json
operation_id
string<uuid>
required

New UUID for each write. Retrying with the same ID and body returns the original result instead of repeating the write.

name
string
required

File name, without path separators.

Required string length: 1 - 200
size_bytes
integer
required

Exact upload size in bytes, up to 1.5 GB.

Required range: 1 <= x <= 1610612736
mime_type
enum<string>
required

audio/mpeg for MP3 or audio/wav for WAV.

Available options:
audio/mpeg,
audio/wav
project_id
string | null

Project that owns the file. Omit for a personal file.

Required string length: 1 - 128
Pattern: \S

Response

The created file, with status uploading.

id
string
required

File ID.

project_id
string | null
required

Project that owns the file; null for a personal file.

name
string
required

File name.

revision
integer
required

Current revision. Send it as expected_revision to rename or delete.

status
enum<string>
required

uploading until the upload is completed, then queued and running while processing, and finally ready or failed.

Available options:
uploading,
queued,
running,
ready,
failed
frames
integer | null
required

Length in frames at sample_rate, once processed.

sample_rate
integer
required

Frame rate used for all Studio timing: 48000.

size_bytes
integer | null
required

Original upload size in bytes.

error_code
string | null
required

Error code when processing failed.

error_reason
string | null
required

Machine-readable failure reason.

error_message
string | null
required

Readable failure message.

references
integer
required

Number of instances that use the file.