Skip to main content
PUT
Update AI Assistant

Authorizations

x-public-key
string
header
required
x-private-key
string
header
required

Headers

x-public-key
string
required
x-private-key
string
required
workspace
string
required

Path Parameters

assistantId
string
required

Body

application/json

All fields are optional. Variant type cannot be changed.

name
string
Maximum string length: 40
variant
object

Only config can be updated — type cannot be changed.

agent
object
telephony
object

Telephony numbers linked to the assistant. Each value is the _id of a telephony number (from GET /v1/number-pool/{telephonyNumberId} or POST /v1/number-pool/purchase).

  • inbound — the phone number customers call to reach this assistant. When someone dials it, the assistant picks up automatically and follows its systemPrompt. Only one assistant can hold an inbound number at a time; assigning it here removes it from any other assistant.
  • outbound — the caller ID shown to customers when the assistant places an outgoing call.

Auto-assignment: In production, the first assistant in a new workspace automatically receives the workspace's default number as outbound. Additional assistants must be assigned numbers explicitly.

analysisPlan
object

Post-call AI evaluation configuration. After each call ends, the platform runs these prompts against the call recording and transcript. Results are returned in the end-of-call webhook event and visible in the call dashboard.

preCall
object

Configure or replace pre-call enrichment during assistant update. Supports templated apiPlan.headers and apiPlan.body values from per-call variableValues.

icpContext
object
callSettings
object
knowledgeBase
object

Combined knowledge base containing both documents and FAQ entries.

Response

Assistant Updated

assistantId
string