Ecologi connects to a Nagent workspace with an API key. Once it is connected, agents can call 5 Ecologi actions, such as "Get User Carbon Offset", "Get User Carbon Removal" and "Get User Habitat Restoration". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Ecologi, with input parameters and output schema.
ECOLOGI_GET_USER_CARBON_OFFSETTool to get the total tonnes of CO2e emissions a user has avoided (carbon offset). Data refreshes every 10 minutes. No authentication required.
Input parameters
Your Ecologi username
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ECOLOGI_GET_USER_CARBON_REMOVALTool to retrieve the total tonnes of CO₂e a user has permanently removed from the atmosphere. Data refreshes every 10 minutes. Use when checking carbon offset impact for a specific Ecologi user or business.
Input parameters
The Ecologi username to retrieve carbon removal data for. This is the unique identifier for the user or business on Ecologi.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ECOLOGI_GET_USER_HABITAT_RESTORATIONTool to get the total area of habitat and ecosystem a user has restored. Data refreshes every 10 minutes. No authentication required.
Input parameters
Your Ecologi username to retrieve habitat restoration data for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ECOLOGI_GET_USER_IMPACTTool to get a combination of all impact types a user has funded: trees, carbon avoidance, carbon removal, and habitat restoration, in a single request. Data refreshes every 10 minutes and no authentication is required.
Input parameters
Your Ecologi username to fetch impact data for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ECOLOGI_GET_USER_TREESTool to get the total number of trees a user has funded on Ecologi. Use when you need to retrieve tree statistics for a specific user. Data refreshes every 10 minutes.
Input parameters
Your Ecologi username
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 5 Ecologi actions on Nagent, including "Get User Carbon Offset", "Get User Carbon Removal" and "Get User Habitat Restoration". Get User Carbon Offset: Get the total tonnes of CO2e emissions a user has avoided (carbon offset). Each action is listed on this page with its input parameters and its output.
Ecologi connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get User Carbon Offset takes 1 required input: username. It returns data, error and successful.