create-webplugin-deployment

Authorizations

x-api-key

string

header

required

API key from Rapida credentials.

Headers

x-client-source

enum<string>

default:sdk

Client source identifier. SDK clients send this automatically.

Available options:

sdk

x-auth-id

string

Optional user identifier to propagate with the request.

Body

application/json

assistantId

string

required

Assistant ID for the web plugin deployment.

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

greeting

string

First message the assistant sends when the web plugin session starts.

Example:

"Hi, how can I help you today?"

greetingInterruptible

boolean

Controls whether users can interrupt the opening greeting in audio sessions.

Example:

true

mistake

string

Message to use when the assistant cannot understand or handle the input.

Example:

"Sorry, I did not understand that."

unclearInputTimeout

number<double>

Seconds to wait after interrupted or unclear input before asking the user to repeat.

Required range: 0.5 <= x <= 5

Example:

0.5

unclearInputMessage

string

Message sent when the assistant could not understand the user input.

Maximum string length: 500

Example:

"I didn't catch that. Could you repeat that?"

idealTimeout

integer<uint64>

Idle timeout in seconds before the assistant sends the timeout message.

Required range: 5 <= x <= 120

Example:

30

idealTimeoutBackoff

integer<uint64>

Number of idle-timeout retries before the session can end.

Required range: 0 <= x <= 5

Example:

2

idealTimeoutMessage

string

Message sent when the web plugin session reaches the idle timeout.

Example:

"Are you still there?"

maxSessionDuration

integer<uint64>

Maximum web plugin session duration in seconds.

Required range: 180 <= x <= 600

Example:

300

suggestion

string[]

Suggested starter prompts shown in the web widget.

Example:

["Book a demo", "Talk to support"]

inputAudio

object

Hide child attributes

inputAudio.audioProvider

string

required

Audio provider name.

Example:

"deepgram"

inputAudio.audioOptions

object[]

Provider-specific audio options.

Hide child attributes

inputAudio.audioOptions.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

inputAudio.audioOptions.key

string

inputAudio.audioOptions.value

string

inputAudio.status

string

Optional provider status.

Example:

"active"

inputAudio.audioType

string

Audio direction or role, such as stt or tts.

Example:

"stt"

outputAudio

object

Hide child attributes

outputAudio.audioProvider

string

required

Audio provider name.

Example:

"deepgram"

outputAudio.audioOptions

object[]

Provider-specific audio options.

Hide child attributes

outputAudio.audioOptions.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

outputAudio.audioOptions.key

string

outputAudio.audioOptions.value

string

outputAudio.status

string

Optional provider status.

Example:

"active"

outputAudio.audioType

string

Audio direction or role, such as stt or tts.

Example:

"stt"

Response

Assistant web plugin deployment created.

code

integer<int32>

Example:

200

success

boolean

Example:

true

data

object

Hide child attributes

data.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.greeting

string

data.greetingInterruptible

boolean

data.mistake

string

data.unclearInputTimeout

number<double>

Required range: 0.5 <= x <= 5

data.unclearInputMessage

string

Maximum string length: 500

data.inputAudio

object

Hide child attributes

data.inputAudio.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.inputAudio.audioType

string

data.inputAudio.audioProvider

string

data.inputAudio.audioOptions

object[]

Hide child attributes

data.inputAudio.audioOptions.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.inputAudio.audioOptions.key

string

data.inputAudio.audioOptions.value

string

data.inputAudio.status

string

data.outputAudio

object

Hide child attributes

data.outputAudio.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.outputAudio.audioType

string

data.outputAudio.audioProvider

string

data.outputAudio.audioOptions

object[]

Hide child attributes

data.outputAudio.audioOptions.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.outputAudio.audioOptions.key

string

data.outputAudio.audioOptions.value

string

data.outputAudio.status

string

data.suggestion

string[]

data.status

string

data.maxSessionDuration

integer<uint64>

Required range: 180 <= x <= 600

data.idealTimeout

integer<uint64>

Required range: 5 <= x <= 120

data.idealTimeoutBackoff

integer<uint64>

Required range: 0 <= x <= 5

data.idealTimeoutMessage

string

error

object

Platform error response details. errorCode is a stable platform error code. See PlatformErrorCode for documented code/message mappings.

Hide child attributes

error.errorCode

string

Stable platform error code.

Pattern: ^[0-9]+$

Example:

"1002003"

error.errorMessage

string

Stable client-safe error message.

Example:

"missing toNumber parameter"

error.humanMessage

string

Client-safe human-readable message.

Example:

"Please provide the required toNumber parameter."

Assistant

Assistant deployments

Calls

Authorizations

Headers

Body

Response