ultron-ai-sdk 1.1.4 → 1.1.6

package/README.md

@@ -50,7 +50,7 @@ npm install ultron-ai-sdk
 <script type="importmap">
         {
           "imports": {
-            "ultron-ai-sdk": "https://cdn.jsdelivr.net/npm/ultron-ai-sdk@1.0.4/dist/index.mjs?module"            
+            "ultron-ai-sdk": "https://cdn.jsdelivr.net/npm/ultron-ai-sdk@1.1.6/dist/index.mjs?module"            
           }
         }
 </script>
@@ -70,8 +70,9 @@ npm install ultron-ai-sdk
                 // 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
+                hideClickMessage: true  // Remove default "Click message" on the avatar
+                alwaysListen: false,    // For Push to talk conversation
+                highFidelityMode: true  // Enables higher graphics quality (can impact performance on low-end devices)
             }
         }
         await sceneCanvas.init(initializationSetting)
@@ -98,6 +99,14 @@ Check out our website for demo at: [🔗Talk to Avatar in metabrix website](http
 
 
 
+---
+
+#### Sample App with React
+
+Check out the sample app git repository: [🔗React SDK Sample](https://github.com/METABRIX-ORG/react-sdk-sample)
+
+
+
 ---
 
 ## Target HTML Element
@@ -114,8 +123,17 @@ Check out our website for demo at: [🔗Talk to Avatar in metabrix website](http
 
 ```javascript
 
-const sceneCanvas = new SceneCanvas('target-html-element')
-sceneCanvas.init({sessionId: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxx"})
+        let sceneCanvas = new SceneCanvas('target-html-element')
+        
+        await sceneCanvas.init({
+            avatarId: "AVATAR_ID",    
+            config:{
+                sessionId: "SESSION_ID_FOR_CURRENT_USER"} // Recomended method for Secure access
+                apiKey: YOUR_API_KEY                    // Only for quick testing (Not recommended for production)
+            })
+        let character = sceneCanvas.character
+
+    // Use Either sessionId or apiKey (Not Both)
 
 ```
 
@@ -134,7 +152,7 @@ To get API key of your ultron account follow the steps below
 
 ### STEP 1: Click on account at top right corner
 
-![Avatar ID step 1](https://media.ultronai.me/Images/website/apikeysh1.png)
+![Avatar ID step 1](https://media.ultronai.me/images/1748686963599-intrustion_1_new.png)
 
 ### STEP 2: Select API key from dropdown
 
@@ -177,21 +195,22 @@ This API allows you to create a new session.
 ```
 
 ```javascript
-async function createSession(apiKey, requestID, expiresIn) {
+async function createSession(apiKey, AvatarId, expireDuration) {
     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 })
+        body: JSON.stringify({ requestID: AvatarId, expiresIn })
     });
 
     const data = await response.json();
     console.log('Session Created:', data);
 }
 
-createSession('your_api_key', '123', 10);
+const response = await createSession('YOUR_API_KEY', 'AVATAR_ID', 500);
+
 
 // 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
@@ -236,17 +255,17 @@ Loads a specific avatar into the container.
 
 To get avatarId follow the steps below
 
-### Step 1: Open the desired avatar in ultron app (app.ultronai.me)
+### Step 1: Open the dashboard and hover the pointer on the desired Avatar (app.ultronai.me)
 
-Click share on top right corner
+You can see different Avatars in different sections and you can copy the Avatar ID of any avatar from here
 
-![Avatar ID step 1](https://media.ultronai.me/Images/website/avateridshar1.png)
 
-### Step 1: Open the desired avatar in ultron app (app.ultronai.me)
+![Avatar ID step 1](https://media.ultronai.me/images/1748685915420-new_instructions.png)
 
-Step 2: Select the avatar id value as from share url
+### Step 2: Click on Copy ID
+
+The Avatar ID will be copied and can be used in SDK
 
-![Avatar ID step 2](https://media.ultronai.me/Images/website/avartaridshare2.png)
 
 ---
 
@@ -290,7 +309,7 @@ ultronSDK.setAudioInputDevice(myDevice.deviceId)
 
 ## Best Practices
 
-- Always initialize the SDK with a valid API key
+- Always initialize the SDK with a valid SessionId
 - Implement error handling for load failures
 - Clean up resources when removing the avatar
 - Optimize container size for better performance
@@ -402,6 +421,9 @@ Then add a handler to process transcribed speech:
 character.onSpeechTranscribed = async (text) => {
   console.log("User said:", text);
 
+
+/////////////////////////// Your AI Workflow ///////////////////////////////////////
+  // The section below can be any API which chats with AI like openai or your own agentic API (Text to text)
   // Send the transcribed text to your AI API
   const response = await fetch("https://your-ai-api.com/endpoint", {
     method: "POST",
@@ -411,8 +433,13 @@ character.onSpeechTranscribed = async (text) => {
 
   const data = await response.json();
 
+  const AIResponseText = data.responseText
+
+  //////////////////////////////////////////////////////////////////////////////////
+
+
   // Speak the AI response using the character
-  character.speak(data.reply);
+  character.say(AIResponseText);
 };
 ```