Skip to main content
PATCH
Update Assistant

Authorizations

X-API-Key
string
header
required

Path Parameters

assistant_id
string
required

Body

application/json
name
string | null
model
CreateAssistantDtoModel · object | null
voice
CreateAssistantDtoVoice · object | null
firstMessageMode
enum<string> | null
Available options:
assistant-speaks-first,
assistant-speaks-first-with-model-generated-message,
assistant-waits-for-user
hipaaEnabled
boolean | null
default:false
clientMessages
string[] | null
serverMessages
enum<string>[] | null

"end-of-call-report",

Available options:
end-of-call-report
silenceTimeoutSeconds
number | null
maxDurationSeconds
number | null
backgroundSound
enum<string> | null

"off", "office"

Available options:
off,
office
backgroundDenoisingEnabled
boolean | null
modelOutputInMessagesEnabled
boolean | null
transportConfigurations
TransportConfigurationTwilio · object[] | null
firstMessage
string | null
voicemailDetection
VoicemailDetection · object | null
voicemailMessage
string | null
default:""
endCallMessage
string | null
endCallPhrases
string[] | null
metadata
Metadata · object | null
serverUrl
string | null

Server URL must match either workflow.amira.bot or workflow.voicebot.studio

serverUrlSecret
string | null
analysisPlan
changedAssistantAnalysisPlan · object | null

This is the analysis plan for the assistant.

artifactPlan
ArtifactPlan · object | null
messagePlan
MessagePlan · object | null
startSpeakingPlan
StartSpeakingPlan · object | null
stopSpeakingPlan
StopSpeakingPlan · object | null
monitorPlan
MonitorPlan · object | null
transcriber
CreateAssistantDtoTranscriber · object | null
dialKeypadFunctionEnabled
boolean | null
endCallFunctionEnabled
boolean | null
forwardingPhoneNumber
string | null

Response

Successful Response

id
string
required
name
string
required
organizationId
string
required
createdBy
string
required
createdAt
string
required
updatedAt
string
required
model
CreateAssistantDtoModel · object | null
voice
CreateAssistantDtoVoice · object | null
transcriber
CreateAssistantDtoTranscriber · object | null
analysisPlan
changedAssistantAnalysisPlan · object | null

This is the analysis plan for the assistant.

serverUrl
string | null

Server URL must match either workflow.amira.bot or workflow.voicebot.studio

serverUrlSecret
string | null
artifactPlan
ArtifactPlan · object | null
messagePlan
MessagePlan · object | null
startSpeakingPlan
StartSpeakingPlan · object | null
stopSpeakingPlan
StopSpeakingPlan · object | null
monitorPlan
MonitorPlan · object | null
clientMessages
string[] | null
dialKeypadFunctionEnabled
boolean | null
endCallFunctionEnabled
boolean | null
forwardingPhoneNumber
string | null