Skip to content

Retrieve Agent Data Summary

Retrieve a summary of all data available to an agent.

GET /agents/{agentId}/data-summary


agentId string Required

The unique identifier of the agent.


Request
import Inconvo from "@inconvoai/node";
const inconvo = new Inconvo({
apiKey: process.env.INCONVO_API_KEY
});
const summary = await inconvo.agents.dataSummary.retrieve(
"agt_3bf1sa45"
);
console.log(summary);
Response
{
"dataSummary": "• organisations - Stores information about organizations including their name and creation date. • users - Contains user details such as contact info, location, and association with an organization. • products - Holds product data including category, price, stock level, and linked organization. • orders - Records purchase transactions linking users, products, and organizations with pricing details. • reviews - Captures user ratings and comments on products within organizations."
}
curl -X GET "https://app.inconvo.ai/api/v1/agents/agt_3bf1sa45/data-summary" \
-H "Authorization: Bearer $INCONVO_API_KEY" \
-H "Accept: application/json"
Response
{
"dataSummary": "• organisations - Stores information about organizations including their name and creation date. • users - Contains user details such as contact info, location, and association with an organization. • products - Holds product data including category, price, stock level, and linked organization. • orders - Records purchase transactions linking users, products, and organizations with pricing details. • reviews - Captures user ratings and comments on products within organizations."
}