ultron-ai-sdk 1.0.4 → 1.0.6

package/README.md

@@ -7,6 +7,8 @@
 
 ## Installation
 
+### Via npm
+
 ```bash
 npm install ultron-ai-sdk
 
@@ -26,7 +28,6 @@ npm install ultron-ai-sdk
         const initializationSetting= {
             avatarId: "AVATAR_ID",       // AvatarId and Request Id are same
             config:{
-                accessToken: 'YOUR_CURRENT_AUTH_TOKEN',   // Can be accessed from your app.ultronai.me localstorage data
                 apiKey: "YOUR_ULTRON_API_KEY"
             },
             options:{
@@ -41,6 +42,56 @@ npm install ultron-ai-sdk
 
 ```
 
+### In HTML Via CDN like [jsDelivr](https://www.jsdelivr.com/).
+
+
+```html
+
+<script type="importmap">
+        {
+          "imports": {
+            "ultron-ai-sdk": "https://cdn.jsdelivr.net/npm/ultron-ai-sdk@1.0.4/dist/index.mjs?module"            
+          }
+        }
+</script>
+
+<script type="module">
+    import {SceneCanvas, Character} from 'ultron-ai-sdk';        
+        
+    let sceneCanvas
+    let character
+    
+    const init = async() => {
+        sceneCanvas = new SceneCanvas('target-html-element')
+        const initializationSetting= {
+            avatarId: "AVATAR_ID",       // AvatarId and Request Id are same
+            config:{
+                apiKey: "YOUR_ULTRON_API_KEY"               // Not required if you can create and access "sessionId" 
+                // sessionId: "SESSION_ID_FOR_CURRENT_USER" // Recomended method for secure access
+            },
+            options:{
+                hideClickMessage: true //remove default "Click message" on the avatar
+                alwaysListen: false    // For Push to talk conversation
+            }
+        }
+        await sceneCanvas.init(initializationSetting)
+        character = sceneCanvas.character
+
+        // Use "character" object to call various methods like .chat() or .say()
+
+        // character.say("Hello world")
+        // character.chat("Please introduce yourself")
+
+        //IMPORTANT --->
+        // User interaction like click is necessory for the talking of the Avatar to work due to inbuilt security in variuos browser
+                    
+    }
+    init()  // You can also call this on user interaction like clicking on support/chat icon.
+
+</script>
+
+```
+
 #### Quick Demo
 
 Check out our website for demo at: [🔗Talk to Avatar in metabrix website](https://dev-website.ultronai.me)
@@ -62,8 +113,10 @@ Check out our website for demo at: [🔗Talk to Avatar in metabrix website](http
 ### Initialization
 
 ```javascript
+
 const sceneCanvas = new SceneCanvas('target-html-element')
-sceneCanvas.init(config)
+sceneCanvas.init({sessionId: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxx"})
+
 ```
 
 ---
@@ -72,7 +125,6 @@ sceneCanvas.init(config)
 
 | Option      | Description |
 |-------------|--------------|
-| `accessToken` (optional) | accessToken current logged in Account |
 | `sessionId` (optional) | Session Id obtained using API key |
 | `apiKey` | You ultron key which can be found in your profile in Ultron App |
 
@@ -92,9 +144,78 @@ To get API key of your ultron account follow the steps below
 
 ![Avatar ID step 1](https://media.ultronai.me/Images/website/apishe3.png)
 
+#### Session Id (sessionId)
+
+## 🔑 Create Session API
+
+This API allows you to create a new session.
+
+### 📌 Endpoint
+**POST** `/session/create`
+
+### 🔧 Headers:
+| Key       | Value            |
+|-----------|-----------------|
+| `x-api-key` | your_api_key    |
+| `Content-Type` | application/json |
+
+### 📤 Request Body:
+```json
+{
+    "expiresIn": "100",
+    "requestID": "xxxxx"
+}
+```
+### Response:
+```json
+
+{
+  "sessionId": "string",
+  "status": "string"
+}
+
+```
+
+```javascript
+async function createSession(apiKey, requestID, expiresIn) {
+    const response = await fetch('https://api.ultronai.me/session/create', {
+        method: 'POST',
+        headers: {
+            'x-api-key': apiKey,
+            'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({ requestID, expiresIn })
+    });
+
+    const data = await response.json();
+    console.log('Session Created:', data);
+}
+
+createSession('your_api_key', '123', 10);
+
+// Use this sessionId in the SDK in your Web App
+// Call this method on your server side for security and avoid exposing your API key
+
+```
+Note: Please use the method above to get session id on your server side for a secure workflow
 
 ---
 
+## Options
+
+## Always listen
+
+Makes the character listen all the time once click  for continous conversation (voice to voice)
+
+- `alwaysListen`: **Boolean** - The unique identifier for the avatar
+
+## Hide default click message
+
+Hides the default text message on the avatar to prompt user to click as an initial click is required for any audio to play in any browser
+
+- `hideClickMessage`: **Boolean** - The unique identifier for the avatar
+
+
 ## Core Methods
 
 ### loadAvatar(avatarId)
@@ -185,7 +306,7 @@ ultronSDK.setAudioInputDevice(myDevice.deviceId)
         const initializationSetting= {
             avatarId: "AVATAR_ID/REQUEST_ID",
             config:{
-                apiKey: "YOUR_ULTRON_API_KEY"
+                sessionId: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxx"
             },
             options:{
                 alwaysListen: false // For Push to talk conversation