Skip to main content
PATCH
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.

Path Parameters

file_id
string
required

Audio file ID.

Body

application/json
expected_revision
integer
required

The file's current revision. A stale revision returns 409.

Required range: x >= 1
name
string
required

New file name.

Required string length: 1 - 200

Response

The updated file.

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.