Skip to main content
PATCH
cURL

Continue building

Manage Studio projects

Import scripts, edit safely, and retry writes.

List clips

Read a project’s script and clip settings.

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.

title
string | null

Project title.

Required string length: 1 - 120
description
string | null

Project description.

Maximum string length: 1000
tts_settings
TtsSettings · object | null

TTS model and language settings.

default_voice_id
string | null

Voice given to new clips that do not set voice_id.

Required string length: 1 - 128
Pattern: \S
default_instructions
string | null

Delivery instructions for clips with empty instructions.

Maximum string length: 1000
default_silence_ms
integer | null

Silence after each clip in milliseconds, unless the clip sets trailing_silence_ms.

Required range: 0 <= x <= 600000

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.