Skip to main content
POST
Update an assistant

Authorizations

Authorization
string
header
required

Project API key (sk_api_…).

Path Parameters

realtimeAssistantId
string<uuid>
required

Body

application/json
name
string

An empty string is accepted.

description
string
config
object

Keys beyond those listed are stored and returned unchanged.

public
boolean

Allows anyone to open a browser session against this assistant without an API key. On a published assistant, the change takes effect at the next publish.

Response

The assistant as stored after the update.

realtimeAssistantId
string<uuid>
organizationId
string<uuid>
projectId
string<uuid>
name
string
description
string
config
object

Keys beyond those listed are stored and returned unchanged.

public
boolean
createdAt
string<date-time>
updatedAt
string<date-time>
createdBy
string

Who created the assistant — an API key or a portal user.

updatedBy
string
version
integer

The version this response shows. Every save bumps it, so published numbers skip the saves in between.

Required range: x >= 1