Skip to main content
PATCH
Updates a prompt-based agent and deploys the change immediately. Only the fields you include in the body are changed.
Flow agents cannot be modified via the API — PATCH on a conversationalFlow agent returns 422. Edit flow agents in the dashboard.

Path Parameters

string
required
The agent’s unique identifier (UUID).

Body Parameters

All optional — include only what you want to change.
string
string
string
string
Voice display name (Sapir, Steve, Ori, Yael, Guy, Gefen, Gal, Gabriel).
string
array
Replaces the provided-variable set. Same item shape as Create Agent.
array
Replaces the extracted-variable set. Same item shape as Create Agent.

Response

The updated Agent object.