Categories:
Agent base plugin
Agent base plugin description for aura-configuration-api
Introduction
The agent-base plugin defines services associated with the management of agents base in aura-configuration-api server.
All these services are defined in the agents-base namespace (/agents-base).
Servers definition
By default, the servers defined in the swagger include the base path (for v2):
/aura-services/v2/configuration.
Therefore, in order to access the services, the base path and service path must be used.
Examples:
- aura-services/v2/configuration/agents-base
- aura-services/v2/configuration/agents-base/{agentBaseId}
Endpoints
| Path | Method | Description |
|---|---|---|
| /agents-base/ | GET | Get all agent base information |
| /agents-base/ | POST | Add a new agent base |
| /agents-base/{agentBaseId} | GET | Get agent base information using agent base id |
| /agents-base/{agentBaseId} | PUT | Replace agent base information associated to agent base id |
| /agents-base/{agentBaseId} | PATCH | Update some fields of agent base information using agent base id |
| /agents-base/{agentBaseId} | DELETE | Delete agent base information using agent base id |
You can read the complete documentation of each service in the aura-configuration-api agent base swagger file.
Retrieving information from agents base
Retrieving specific fields from agent base information
It is possible to get only a specific list of fields for agent base information, reducing the amount of data transmitted when necessary, using the includeFields query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/agents-base?includeFields=id,name' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: XXX'
Response example:
[
{
"id": "cd2b534c-16c3-4d89-a87e-ec45d3939232",
"name": "device-recommender-agent",
}
]
Excluding fields in agent base information
It is also possible to exclude agent base information fields using the excludeFields query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/agents-base?excludeFields=metadata,name' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: APIKEY XXX'
Response example:
[
{
"id": "cd2b534c-16c3-4d89-a87e-ec45d3939232",
"description": "An AI agent built with langgraph that provides personalized recommendations about devices by querying and analyzing data stored in a MongoDB database.",
"language": "python",
"version": "1.0.0"
}
]
Filtering agent base information
It is possible to filter agent base information using the filter query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/agents-base?filter=language:python' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: APIKEY XXX'
Database
The complete definition of the data model can be found in agent base collection section within the administration module.