docs response format updated

Author: rawatSingh2022

docs/api/apiaccess/agent/findAgent.md

@@ -35,15 +35,25 @@ data:
 
 ### Response Structure
 
-The method returns a Promise that resolves to a `FindAgentByTaskResponse` object with:
-- `type`: The response type, always "findAgentByTaskResponse"
-- `agents`: Array of found agents, each containing:
-  - `type`: The agent type, typically "function"
-  - `function`: Agent function details including:
-    - `name`: The name/identifier of the agent
-    - `description`: Detailed description of the agent's capabilities
-    - `parameters`: Parameter specification object with type, properties, required fields, and additionalProperties flag
-    - `strict`: Boolean indicating whether the agent enforces strict parameter validation
+The method returns a Promise that resolves to a `FindAgentByTaskResponse` object with the following properties:
+
+**Response Properties:**
+- `type`: Always "findAgentByTaskResponse"
+- `agents`: Optional array of agent objects containing found agents
+- `success`: Optional boolean indicating if the operation was successful
+- `message`: Optional string with additional information
+- `error`: Optional string containing error details if the operation failed
+- `messageId`: Optional unique identifier for the message
+- `threadId`: Optional thread identifier
+
+**Agent Structure:**
+Each agent in the `agents` array has the following structure:
+- `type`: Always "function"
+- `function`: Agent function details including:
+  - `name`: The name/identifier of the agent
+  - `description`: Detailed description of the agent's capabilities
+  - `parameters`: Parameter specification object with type, properties, required fields, and additionalProperties flag
+  - `strict`: Optional boolean indicating whether the agent enforces strict parameter validation
 
 ### Examples
 

docs/api/apiaccess/agent/getAgentsDetail.md

@@ -23,21 +23,28 @@ data:
 
 ### Response Structure
 
-The method returns a Promise that resolves to an `AgentsDetailResponse` object with:
-- `type`: "agentsDetailResponse"
-- `messageId`: Unique message identifier string
-- `threadId`: Thread identifier string
-- `success`: Boolean indicating if the request was successful
-- `payload`: Object containing the actual data:
-  - `agents`: Array of detailed agent objects, each containing:
-    - `id`: Unique agent identifier
-    - `name`: Agent display name
-    - `description`: Agent description text
-    - `capabilities`: Array of agent capabilities (may be empty)
-    - `isLocal`: Boolean indicating if the agent is local
-    - `version`: Version string of the agent
-    - `status`: Numeric status code (1 = active)
-    - `unique_id`: Unique identifier string for the agent
+The method returns a Promise that resolves to an `AgentsDetailResponse` object with the following properties:
+
+**Response Properties:**
+- `type`: Always "agentsDetailResponse"
+- `payload`: Optional object containing the actual agent details data
+  - `agents`: Array of agent detail objects with detailed agent information
+- `success`: Optional boolean indicating if the operation was successful
+- `message`: Optional string with additional information
+- `error`: Optional string containing error details if the operation failed
+- `messageId`: Optional unique identifier for the message
+- `threadId`: Optional thread identifier
+
+**Agent Detail Structure:**
+Each agent in the `payload.agents` array has the following structure:
+- `id`: Unique agent identifier
+- `name`: Agent display name
+- `description`: Agent description text
+- `capabilities`: Optional array of agent capabilities
+- `isLocal`: Boolean indicating if the agent is local
+- `version`: Version string of the agent
+- `status`: String status of the agent
+- `unique_id`: Unique identifier string for the agent
 
 ### Examples
 
@@ -54,8 +61,9 @@ if (agentsList?.agents && agentsList.agents.length > 0) {
     // Get detailed information for the selected agents
     const agentsDetailResult = await codebolt.agent.getAgentsDetail(agentIds);
     console.log('Agent details result type:', agentsDetailResult?.type); // "agentsDetailResponse"
-    console.log('Message ID:', agentsDetailResult?.messageId);
     console.log('Success:', agentsDetailResult?.success);
+    console.log('Message ID:', agentsDetailResult?.messageId);
+    console.log('Thread ID:', agentsDetailResult?.threadId);
     console.log('Details count:', agentsDetailResult?.payload?.agents?.length || 0);
     console.log('Agent details:', agentsDetailResult);
 
@@ -64,15 +72,20 @@ if (agentsList?.agents && agentsList.agents.length > 0) {
         const firstAgent = agentsDetailResult.payload.agents[0];
         console.log('First agent ID:', firstAgent.id);
         console.log('First agent name:', firstAgent.name);
+        console.log('First agent description:', firstAgent.description);
         console.log('First agent version:', firstAgent.version);
         console.log('First agent is local:', firstAgent.isLocal);
+        console.log('First agent status:', firstAgent.status);
+        console.log('First agent unique_id:', firstAgent.unique_id);
+        console.log('First agent capabilities:', firstAgent.capabilities);
     }
 }
 
 // Example 2: Get details for all agents (using empty array)
 const allAgentDetails = await codebolt.agent.getAgentsDetail([]);
 console.log('All agent details:', allAgentDetails);
 console.log('Success:', allAgentDetails?.success);
+console.log('Type:', allAgentDetails?.type);
 console.log('Total agents:', allAgentDetails?.payload?.agents?.length || 0);
 
 // Display each agent's key information
@@ -81,15 +94,18 @@ if (allAgentDetails?.payload?.agents) {
         console.log(`Agent ${index + 1}:`);
         console.log(`  - ID: ${agent.id}`);
         console.log(`  - Name: ${agent.name}`);
+        console.log(`  - Description: ${agent.description}`);
         console.log(`  - Version: ${agent.version}`);
         console.log(`  - Status: ${agent.status}`);
         console.log(`  - Is Local: ${agent.isLocal}`);
         console.log(`  - Unique ID: ${agent.unique_id}`);
+        console.log(`  - Capabilities: ${agent.capabilities || 'None'}`);
     });
 }
 ```
 
 ### Usage Notes
 
 - Agent IDs can be obtained from the `getAgentsList()` method using `agent.function?.name`
-- Pass an empty array `[]` to get details for all available agents
+- Pass an empty array `[]` to get details for all available agents
+- The response includes both basic WebSocket response properties and detailed agent information in the `payload` field

docs/api/apiaccess/agent/getAgentsList.md

@@ -12,7 +12,7 @@ cbparameters:
     description: A promise that resolves with the list of agents
     typeArgs:
       - type: reference
-        name: AgentsListResponse
+        name: ListAgentsResponse
 data:
   name: getAgentsList
   category: agent
@@ -23,9 +23,25 @@ data:
 
 ### Response Structure
 
-The method returns a Promise that resolves to an `AgentsListResponse` object with:
-- `type`: Response type identifier
-- `agents`: Array of agent objects containing agent information
+The method returns a Promise that resolves to a `ListAgentsResponse` object with the following properties:
+
+**Response Properties:**
+- `type`: Always "listAgentsResponse"
+- `agents`: Optional array of agent objects containing agent information
+- `success`: Optional boolean indicating if the operation was successful
+- `message`: Optional string with additional information
+- `error`: Optional string containing error details if the operation failed
+- `messageId`: Optional unique identifier for the message
+- `threadId`: Optional thread identifier
+
+**Agent Structure:**
+Each agent in the `agents` array has the following structure:
+- `type`: Always "function"
+- `function`: Agent function details including:
+  - `name`: The name/identifier of the agent
+  - `description`: Detailed description of the agent's capabilities
+  - `parameters`: Parameter specification object with type, properties, required fields, and additionalProperties flag
+  - `strict`: Optional boolean indicating whether the agent enforces strict parameter validation
 
 ### Examples
 
@@ -34,6 +50,7 @@ The method returns a Promise that resolves to an `AgentsListResponse` object wit
 const downloadedAgents = await codebolt.agent.getAgentsList('downloaded');
 console.log('✅ Agents list result:', downloadedAgents);
 console.log('   - Type:', downloadedAgents?.type);
+console.log('   - Success:', downloadedAgents?.success);
 console.log('   - Agents count:', downloadedAgents?.agents?.length || 0);
 if (downloadedAgents?.agents?.length > 0) {
     console.log('   - First agent:', downloadedAgents.agents[0]);
@@ -46,12 +63,14 @@ if (downloadedAgents?.agents?.length > 0) {
 const allAgents = await codebolt.agent.getAgentsList('all');
 console.log('✅ All agents result:', allAgents);
 console.log('   - Type:', allAgents?.type);
+console.log('   - Success:', allAgents?.success);
 console.log('   - Total agents count:', allAgents?.agents?.length || 0);
 
 // Example 3: Getting list of local agents
 const localAgents = await codebolt.agent.getAgentsList('local');
 console.log('✅ Local agents result:', localAgents);
 console.log('   - Type:', localAgents?.type);
+console.log('   - Success:', localAgents?.success);
 console.log('   - Local agents count:', localAgents?.agents?.length || 0);
 ```
 

docs/api/apiaccess/agent/startAgent.md

@@ -15,7 +15,7 @@ cbparameters:
     description: A promise that resolves when the agent has been successfully started.
     typeArgs:
       - type: reference
-        name: StartAgentResponse
+        name: TaskCompletionResponse
 data:
   name: startAgent
   category: agent
@@ -26,10 +26,19 @@ data:
 
 ### Response Structure
 
-The method returns a Promise that resolves to a `StartAgentResponse` object with:
-- `status`: Status of the agent start operation
-- `type`: Response type identifier
-- Additional agent-specific response data
+The method returns a Promise that resolves to a `TaskCompletionResponse` object with the following properties:
+
+**Response Properties:**
+- `type`: Always "taskCompletionResponse"
+- `from`: Optional string indicating the source of the response
+- `agentId`: Optional string containing the ID of the agent that was started
+- `task`: Optional string containing the task that was assigned to the agent
+- `result`: Optional field containing any result data from the agent start operation
+- `success`: Optional boolean indicating if the operation was successful
+- `message`: Optional string with additional information
+- `error`: Optional string containing error details if the operation failed
+- `messageId`: Optional unique identifier for the message
+- `threadId`: Optional thread identifier
 
 ### Examples
 
@@ -60,9 +69,10 @@ try {
         const startAgentResult = await codebolt.agent.startAgent("act", startTask);
 
         console.log('✅ Start agent result:', startAgentResult);
-        console.log('   - Agent ID:', agentId);
-        console.log('   - Task:', startTask);
-        console.log('   - Status:', startAgentResult?.status);
+        console.log('   - Agent ID:', startAgentResult?.agentId);
+        console.log('   - Task:', startAgentResult?.task);
+        console.log('   - Success:', startAgentResult?.success);
+        console.log('   - Result:', startAgentResult?.result);
         console.log('   - Response type:', startAgentResult?.type);
     } else {
         console.log('⚠️ No agents found to start');
@@ -75,7 +85,10 @@ try {
 try {
     const startResponse = await codebolt.agent.startAgent("act", "Help me with data analysis");
     console.log('Agent started successfully:', startResponse);
-    console.log('Status:', startResponse?.status);
+    console.log('Agent ID:', startResponse?.agentId);
+    console.log('Task:', startResponse?.task);
+    console.log('Success:', startResponse?.success);
+    console.log('Result:', startResponse?.result);
     console.log('Type:', startResponse?.type);
 } catch (error) {
     console.error('Failed to start agent:', error.message);

docs/api/apiaccess/browser/getContent.md

@@ -16,6 +16,21 @@ data:
 <CBBaseInfo/> 
 <CBParameters/>
 
+### Response Structure
+
+The method returns a Promise that resolves to a `GetContentResponse` object with the following properties:
+
+**Response Properties:**
+- `type`: Always "getContentResponse"
+- `content`: Optional string containing the page content
+- `html`: Optional string containing the HTML content
+- `text`: Optional string containing the text content
+- `success`: Optional boolean indicating if the operation was successful
+- `message`: Optional string with additional information
+- `error`: Optional string containing error details if the operation failed
+- `messageId`: Optional unique identifier for the message
+- `threadId`: Optional thread identifier
+
 ### Example 
 
 ```js 
@@ -29,7 +44,9 @@ await new Promise(resolve => setTimeout(resolve, 2000));
 const contentResult = await codebolt.browser.getContent();
 console.log('✅ Content retrieved:', {
     success: contentResult.success,
-    contentLength: contentResult.content ? contentResult.content.length : 0
+    contentLength: contentResult.content ? contentResult.content.length : 0,
+    hasHtml: !!contentResult.html,
+    hasText: !!contentResult.text
 });
 
 // Access the actual content

docs/api/apiaccess/browser/getUrl.md

@@ -39,21 +39,17 @@ console.log('✅ URL after navigation:', currentUrl);
 
 ### Response Structure
 
-```js
-{
-  event: 'browserActionResponse',
-  eventId: 'getUrl_1750401431606',
-  payload: {
-    content: '"https://www.google.com/"',
-    viewport: { 
-      width: 767, 
-      height: 577 
-    },
-    currentUrl: 'https://www.google.com/'
-  },
-  type: 'getUrlResponse'
-}
-```
+The method returns a Promise that resolves to a `UrlResponse` object with the following properties:
+
+**Response Properties:**
+- `type`: Always "urlResponse"
+- `url`: Optional string containing the URL
+- `currentUrl`: Optional string containing the current URL
+- `success`: Optional boolean indicating if the operation was successful
+- `message`: Optional string with additional information
+- `error`: Optional string containing error details if the operation failed
+- `messageId`: Optional unique identifier for the message
+- `threadId`: Optional thread identifier
 
 ### Explanation
 

docs/api/apiaccess/browser/goToPage.md

@@ -44,21 +44,16 @@ await codebolt.browser.goToPage('https://github.com');
 
 ### Response Structure
 
-```js
-{
-  event: 'browserActionResponse',
-  eventId: 'goToPage_1750401433630',
-  payload: {
-    content: '"Navigated to https://example.com"',
-    viewport: { 
-      width: 767, 
-      height: 577 
-    },
-    currentUrl: 'https://example.com'
-  },
-  type: 'goToPageResponse'
-}
-```
+The method returns a Promise that resolves to a `GoToPageResponse` object with the following properties:
+
+**Response Properties:**
+- `type`: Always "goToPageResponse"
+- `url`: Optional string containing the URL that was navigated to
+- `success`: Optional boolean indicating if the navigation was successful
+- `message`: Optional string with additional information
+- `error`: Optional string containing error details if the operation failed
+- `messageId`: Optional unique identifier for the message
+- `threadId`: Optional thread identifier
 
 ### Explanation
 

docs/api/apiaccess/browser/screenshot.md

@@ -5,7 +5,7 @@ cbbaseinfo:
 cbparameters:
   parameters: []
   returns:
-    signatureTypeName: Promise<ScreenshotResponse>
+    signatureTypeName: Promise<BrowserScreenshotResponse>
     description: A promise that resolves with the screenshot data.
     typeArgs: []
 data:
@@ -16,6 +16,25 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
+### Response Structure
+
+The method returns a Promise that resolves to a `BrowserScreenshotResponse` object with the following properties:
+
+**Response Properties:**
+- `type`: Always "screenshotResponse"
+- `payload`: Optional object containing the response data
+  - `screenshot`: Base64 encoded image data of the screenshot
+  - `fullPage`: Optional boolean indicating if it's a full page screenshot
+  - `success`: Optional boolean indicating if the operation was successful
+  - `content`: Optional string with additional content information
+  - `viewport`: Optional viewport information object
+- `eventId`: Optional string containing the event identifier
+- `success`: Optional boolean indicating if the operation was successful
+- `message`: Optional string with additional information
+- `error`: Optional string containing error details if the operation failed
+- `messageId`: Optional unique identifier for the message
+- `threadId`: Optional thread identifier
+
 ### Example 
 
 ```js 
@@ -28,6 +47,7 @@ await new Promise(resolve => setTimeout(resolve, 2000));
 // Take a screenshot of the current page
 const screenshotResult = await codebolt.browser.screenshot();
 console.log('✅ Screenshot taken:', screenshotResult);
+console.log('Screenshot data available:', !!screenshotResult?.payload?.screenshot);
 ```
 
 ### Explanation