メインコンテンツへスキップ
PATCH
Update Voice

承認

Authorization
string
header
デフォルト:$CARTESIA_API_KEY
必須

Cartesia API key (sk_car_...). Get one at play.cartesia.ai/keys.

ヘッダー

Cartesia-Version
enum<string>
デフォルト:2026-03-01
必須

API version header.

利用可能なオプション:
2026-03-01
:

"2026-03-01"

パスパラメータ

id
string
必須

The ID of the voice. Find one in the Voice Library or via List Voices.

ボディ

application/json
name
string

The name of the voice.

tagline
string

A few words describing the voice. At most 32 characters.

description
string

A description for the voice, typically longer than the tagline if both are provided.

gender
enum<string> | null
利用可能なオプション:
masculine,
feminine,
gender_neutral
access
object

Change who can access the voice

レスポンス

200 - application/json
id
string
必須

The ID of the voice. Find one in the Voice Library or via List Voices.

is_owner
boolean
必須

Whether your organization owns the voice.

access
object
必須

Who can access and list the voice

name
string
必須

The display name of the voice. Does not include the tagline.

tagline
string
デフォルト:""
必須

A short descriptor for the voice (at most 32 characters). Empty string when unset.

description
string
必須

A description for the voice, typically longer than the tagline if both are provided.

created_at
string<date-time>
必須

The date and time the voice was created.

language
string
必須

The voice's language, as an ISO 639-1 code (e.g. en, fr, zh)

:

"en"

is_public
boolean
必須
非推奨

Use access instead. Whether the voice is publicly accessible.

gender
enum<string> | null

The gender of the voice, if specified.

利用可能なオプション:
masculine,
feminine,
gender_neutral
preview_file_url
string | null

A URL to download a preview audio file for this voice. Useful to avoid consuming credits when looking for the right voice. The URL requires the same Authorization header. Voice previews may be changed, moved, or deleted so you should avoid storing the URL permanently. This property will be null if there's no preview available. Only included when expand[] includes preview_file_url.

country
string | null

The country associated with the voice, as an ISO 3166-1 alpha-2 code when available.

:

"US"

is_pro
boolean

Whether this voice is a pro voice clone.

mode
string
非推奨

No longer used.