getAgentsDetail

codebolt.agent.getAgentsDetail(agentList: array): Promise<AgentsDetailResponse>

Retrieves detailed information for a list of specified agents.

Parameters

Name	Type	Description
agentList	array	List of agent IDs to get details for (empty array for all agents).

Returns:

 Promise<AgentsDetailResponse>

A promise that resolves with the detailed information of the specified agents.

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

Examples

// Example 1: Get details for specific agents
// First, get the list of available agents
const agentsList = await codebolt.agent.getAgentsList('downloaded');

if (agentsList?.agents && agentsList.agents.length > 0) {
    // Extract agent IDs from the first few agents
    const agentIds = agentsList.agents.slice(0, 3).map(agent => agent.function?.name);
    console.log('Agent IDs to get details for:', agentIds);
    
    // 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('Details count:', agentsDetailResult?.payload?.agents?.length || 0);
    console.log('Agent details:', agentsDetailResult);
    
    // Access individual agent details
    if (agentsDetailResult?.payload?.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 version:', firstAgent.version);
        console.log('First agent is local:', firstAgent.isLocal);
    }
}

// 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('Total agents:', allAgentDetails?.payload?.agents?.length || 0);

// Display each agent's key information
if (allAgentDetails?.payload?.agents) {
    allAgentDetails.payload.agents.forEach((agent, index) => {
        console.log(`Agent ${index + 1}:`);
        console.log(`  - ID: ${agent.id}`);
        console.log(`  - Name: ${agent.name}`);
        console.log(`  - Version: ${agent.version}`);
        console.log(`  - Status: ${agent.status}`);
        console.log(`  - Is Local: ${agent.isLocal}`);
        console.log(`  - Unique ID: ${agent.unique_id}`);
    });
}

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