Skip to main content
POST
/
v1
/
assistant-deployment
/
create-webplugin-deployment
create-webplugin-deployment
curl --request POST \
  --url https://assistant-01.in.rapida.ai/v1/assistant-deployment/create-webplugin-deployment \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "assistantId": "2227823180112723968"
}
'
{
  "code": 200,
  "success": true,
  "data": {
    "id": "2230142097179373568",
    "assistantId": "2227823180112723968",
    "greeting": "Hi, how can I help you today?",
    "mistake": "Sorry, I did not understand that.",
    "idealTimeout": 30,
    "idealTimeoutBackoff": 2,
    "idealTimeoutMessage": "Are you still there?",
    "maxSessionDuration": 300,
    "suggestion": [
      "Book a demo",
      "Talk to support"
    ],
    "status": "active",
    "inputAudio": {
      "audioProvider": "deepgram",
      "audioType": "stt",
      "status": "active"
    },
    "outputAudio": {
      "audioProvider": "elevenlabs",
      "audioType": "tts",
      "status": "active"
    }
  }
}

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?"

​
mistake
string

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

Example:

"Sorry, I did not understand that."

​
idealTimeout
integer<uint64>

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

Required range: 15 <= 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
​
outputAudio
object

Response

Assistant web plugin deployment created.

​
code
integer<int32>
Example:

200

​
success
boolean
Example:

true

​
data
object
​
error
object

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