Logo
Search
Docs

Get embed

GET https://app.sulus.ai/api/assistants/{assistantId}/embed

Embed widget configuration + ready-to-paste HTML

Authentication

Send a bearer token created on your dashboard's Developer page:

Authorization: Bearer <YOUR_API_KEY>

Path parameters

assistantId string Required

The assistant's public id (UUID).

Validation: uuid — the public assistant_id

Errors

StatusMeaningBody
404 Assistant not found, or outside your account scope {"success":false,"message":"Assistant not found"}
401 Missing or invalid bearer token
403 Feature assistants not enabled for the account

Notes

  • `embed_config` is `defaultEmbedConfig()` merged with any stored overrides — every key listed in the example is always present.
curl --request GET \
  --url https://app.sulus.ai/api/assistants/{assistantId}/embed \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
import requests

url = "https://app.sulus.ai/api/assistants/{assistantId}/embed"
headers = {"Authorization": "Bearer <YOUR_API_KEY>"}

response = requests.get(url, headers=headers)
print(response.json())
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://app.sulus.ai/api/assistants/{assistantId}/embed"
	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer <YOUR_API_KEY>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
Response 200 
{
    "success": true,
    "data": {
        "assistant_id": "9f8e7d6c-5b4a-4c3d-8e2f-1a2b3c4d5e6f",
        "embed_config": {
            "mode": "chat",
            "theme": "light",
            "position": "bottom-right",
            "size": "full",
            "radius": "medium",
            "chatStorage": "session",
            "chatStorageKey": "",
            "baseColor": "#FFFFFF",
            "accentColor": "#d004ee",
            "baseBgColor": "",
            "ctaButtonColor": "#000000",
            "ctaButtonTextColor": "#FFFFFF",
            "mainLabel": "Chat with us",
            "ctaTitle": "",
            "ctaSubtitle": "",
            "startButtonText": "Start",
            "endButtonText": "End Call",
            "emptyChatMessage": "Hi! How can I help you today?",
            "chatPlaceholder": "Type your message...",
            "firstChatMessage": "",
            "chatEndMessage": "",
            "emptyVoiceMessage": "",
            "emptyVoiceActiveMessage": "",
            "emptyHybridMessage": "",
            "showTranscript": false,
            "requireConsent": false,
            "consentTitle": "",
            "termsContent": ""
        },
        "public_key": "pk_live_7f6e5d4c3b2a19081726354453627384",
        "widget_script_url": "https://app.sulus.ai/assets/sulus/widget.umd.js",
        "api_url": "https://app.sulus.ai/api/embed/widget",
        "embed_html": "<script src=\"https://app.sulus.ai/assets/sulus/widget.umd.js\" async type=\"text/javascript\"></script>\n\n<sulus-widget\n  api-url=\"https://app.sulus.ai/api/embed/widget\"\n  assistant-id=\"9f8e7d6c-5b4a-4c3d-8e2f-1a2b3c4d5e6f\"\n  public-key=\"pk_live_7f6e5d4c3b2a19081726354453627384\"\n  mode=\"chat\"\n  theme=\"light\"\n  position=\"bottom-right\"\n  size=\"full\"\n  radius=\"medium\"\n  base-color=\"#FFFFFF\"\n  accent-color=\"#d004ee\"\n  cta-button-color=\"#000000\"\n  cta-button-text-color=\"#FFFFFF\"\n  main-label=\"Chat with us\"\n  start-button-text=\"Start\"\n  end-button-text=\"End Call\"\n  empty-chat-message=\"Hi! How can I help you today?\"\n  chat-placeholder=\"Type your message...\"\n></sulus-widget>"
    }
}