Create Widget

Create a new assistant

POST /api/v1/widget

Create Widget

cURL

curl --request POST \
  --url 'https://api.example.com/api/v1/widget?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "widget_type": "chat",
  "user_opening_messages": [
    "<string>"
  ],
  "action_buttons": [
    "<unknown>"
  ],
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "attributes": {},
  "display_name": "<string>",
  "intro_message": "<string>",
  "header_color": "<string>",
  "user_message_color": "<string>",
  "bot_message_color": "<string>",
  "bot_icon_color": "<string>",
  "remove_branding": false,
  "ice_break_color": "<string>",
  "bubble_color": "<string>",
  "bubble_text": "<string>",
  "bot_text_message_color": "<string>",
  "user_text_message_color": "<string>",
  "header_text_color": "<string>",
  "textbox_default_text": "<string>",
  "action_buttons_color": "<string>",
  "style_params": {}
}
'

201

{
  "message": "Data created successfully",
  "meta": {},
  "data": {
    "widget_type": "chat",
    "user_opening_messages": [
      "<string>"
    ],
    "action_buttons": [
      "<unknown>"
    ],
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "conversation_bot_icon": "<string>",
    "bubble_bot_icon": "<string>",
    "provider_user_friendly_label": "<string>",
    "widget_provider": "<string>",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "attributes": {},
    "display_name": "<string>",
    "intro_message": "<string>",
    "header_color": "<string>",
    "user_message_color": "<string>",
    "bot_message_color": "<string>",
    "bot_icon_color": "<string>",
    "remove_branding": false,
    "ice_break_color": "<string>",
    "bubble_color": "<string>",
    "bubble_text": "<string>",
    "bot_text_message_color": "<string>",
    "user_text_message_color": "<string>",
    "header_text_color": "<string>",
    "textbox_default_text": "<string>",
    "action_buttons_color": "<string>",
    "style_params": {}
  }
}

Authorizations

api_key · string · query · required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Body

application/json

widget_type · enum<string> | null · required

Available options: chat, html, whatsapp, phone, html_call, leadconnector, leadconnector_call, sms, fb_messenger, instagram, web_call, plivo_call, telnyx_call, telegram, render_form, sip

user_opening_messages · string[] | null · required

action_buttons · any[] | null · required

org_id · string<uuid> | null

assistant_id · string<uuid> | null

name · string | null

description · string | null

attributes · Attributes · object

display_name · string | null

intro_message · string | null

header_color · string | null

user_message_color · string | null

bot_message_color · string | null

bot_icon_color · string | null

remove_branding · boolean | null · default: false

ice_break_color · string | null

bubble_color · string | null

bubble_text · string | null

bot_text_message_color · string | null

user_text_message_color · string | null

header_text_color · string | null

textbox_default_text · string | null

action_buttons_color · string | null

style_params · Style Params · object

Response

201

application/json

Successful Response

message · string | null · default: Data created successfully

meta · Meta · object

data · IWidgetRead · object

Show child attributes