Skip to main content
POST
cURL

Continue building

Arrange background audio

Upload files and place them on tracks.

Create an instance

Place audio 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

project_id
string
required

Studio project ID, such as prj_….

Body

application/json
expected_edit_token
string
required

edit_token from your latest read or write of this project. A stale token returns 409.

Required string length: 1 - 128
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

Track name.

Required string length: 1 - 200
chapter_id
string<uuid> | null

Limit the track to this chapter. Omit to span the whole project.

volume
number
default:1

Track volume, from 0 to 2.

Required range: 0 <= x <= 2
muted
boolean
default:false

Whether the track is muted.

Response

The updated project.

project
ProjectView · object
required

The project after this request.

edit_token
string
required

Current edit_token. Send it as expected_edit_token on the next write.

client_refs
Client Refs · object

Import only: each client_ref mapped to its created ID.

created_ids
string[]

IDs created by this request, in order.