Skip to main content
PATCH
Update Agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id
string
required

Body

application/json
name
string | null
Required string length: 1 - 120
description
string | null
Maximum string length: 2000
status
enum<string> | null
Available options:
active,
archived
public_enabled
boolean | null

Allow keyless session creation from the browser SDK, gated by allowed_origins.

allowed_origins
string[] | null
Maximum array length: 20
overrides_allowed
enum<string>[] | null

Which session-creation overrides callers may use. An empty list rejects all overrides.

Maximum array length: 8
Available options:
first_message,
system_prompt,
voice_profile_id,
language

Response

Request fulfilled, document follows

agent_id
string
required
workspace_id
string
required
name
string
required
status
enum<string>
required
Available options:
active,
archived
publication_state
enum<string>
required

live once at least one version is published; draft agents cannot take sessions yet.

Available options:
live,
draft
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string
default:""
public_enabled
boolean
default:false
allowed_origins
string[]
overrides_allowed
enum<string>[]
Available options:
first_message,
system_prompt,
voice_profile_id,
language