Skip to main content
PATCH
Update a tool

承認

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

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

ヘッダー

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

API version header.

利用可能なオプション:
2026-08-14
例:

"2026-08-14"

パスパラメータ

tool_id
string
必須

Unique identifier for the tool.

Minimum string length: 1

ボディ

application/json
api_schema
object
assignments
WebhookAssignment · object[] | null

Replaces the tool's assignments. Send null or [] to remove them all.

Maximum array length: 64
description
string

What the tool does and when the agent should use it.

Required string length: 1 - 2000
execution_mode
enum<string>

Controls how the tool runs relative to the conversation. immediate runs in the current turn and can be interrupted by the caller. async lets the turn finish while the tool runs.

利用可能なオプション:
immediate,
async
name
string

Name the agent uses to call the tool. Names are case-sensitive.

Pattern: ^[a-zA-Z][a-zA-Z0-9_-]{0,63}$
pre_tool_speech
enum<string>

Controls whether the agent speaks before using the tool. auto lets the agent decide, while force asks the agent to speak first.

利用可能なオプション:
auto,
force
response_timeout_secs
integer

Maximum time to wait for the endpoint to respond. Defaults to 20 seconds.

必須範囲: 1 <= x <= 120

レスポンス

Update a tool

api_schema
ManagedWebhookApiSchemaResponse · object
必須
assignments
WebhookAssignment · object[]
必須

Response fields to save as dynamic variables after a successful JSON response

Maximum array length: 64
created_at
string<date-time>
必須

An RFC 3339 / ISO 8601 date-time string with timezone (e.g. 2025-04-16T12:34:56.789Z).

description
string
必須

What the tool does and when the agent should use it.

Required string length: 1 - 2000
execution_mode
enum<string>
必須

Controls how the tool runs relative to the conversation. immediate runs in the current turn and can be interrupted by the caller, while async lets the turn finish while the tool runs.

利用可能なオプション:
immediate,
async
id
string
必須

Unique identifier for the tool.

Minimum string length: 1
name
string
必須

Name the agent uses to call the tool. Names are case-sensitive.

Pattern: ^[a-zA-Z][a-zA-Z0-9_-]{0,63}$
pre_tool_speech
enum<string>
必須

Controls whether the agent speaks before using the tool. auto lets the agent decide, while force asks the agent to speak first.

利用可能なオプション:
auto,
force
response_timeout_secs
integer
デフォルト:20
必須

Maximum time to wait for the endpoint to respond. Defaults to 20 seconds.

必須範囲: 1 <= x <= 120
type
enum<string>
必須

Runs an HTTP request from Cartesia's servers.

利用可能なオプション:
webhook
updated_at
string<date-time>
必須

An RFC 3339 / ISO 8601 date-time string with timezone (e.g. 2025-04-16T12:34:56.789Z).

agents
ManagedAgentSummary · object[]

Agents that currently use this tool. Included when expand[]=agents is requested.