Skip to main content
PATCH
cURL

Continue building

Arrange background audio

Upload files and place them on tracks.

Get a file

Check that audio is ready to place.

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_….

track_id
string
required

Audio track ID, or narration for the narration track.

instance_id
string
required

Audio instance ID.

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.

file_id
string<uuid> | null

Ready audio file to play.

position
Position · object | null

Position fields to change. Omitted fields keep their values.

trim_start
integer | null

First source frame to play.

Required range: 0 <= x <= 1036800000
trim_end
integer | null

Source frame where playback stops. Must be greater than trim_start.

Required range: 1 <= x <= 1036800000
effects
Effects · object | null

Effect fields to change. Omitted fields keep their values.

length
integer | null

Timeline length in frames. When longer than the trimmed audio, the audio repeats. null plays the trimmed audio once.

Required range: 1 <= x <= 1036800000
track_id
string<uuid> | null

Move the instance to this audio track.

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.