Skip to main content
PUT
Update a user prompt

Authorizations

Authorization
string
header
required

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

Path Parameters

promptId
string
required

Body

application/json
name
string

Human-readable prompt name shown in pickers and lists.

prompt
string

XML prompt body driving the AI agent.

responseTime
number

Target reply latency in seconds; the engine throttles streaming to roughly this duration.

description
string

Short summary of the prompt's purpose; surfaced in summary lists and pickers.

temperature
number

Sampling temperature (0-1). Lower = more deterministic.

tools
object[]

Enabled tool keys (e.g. getContact, sendSms, transfer).

toolConfigs
object

Per-tool config overrides keyed by tool name.

Response

Prompt updated successfully (may include a versionSnapshot when a checkpoint was captured)

versionSnapshot is only present when the update created a version checkpoint as a side-effect (e.g. autosave thresholds).

message
string
required
prompt
object
required

Prompt document as stored in the Prompt collection. Returned shape varies slightly per endpoint (some list/summary endpoints project a subset of fields).

Example:
versionSnapshot
object
Example: