Agents
Agents are AI-driven entities you can create, train, and deploy. They analyze data, execute tasks, and adapt in real time.
Retrieve a paginated list of all AI agents, with optional filters for limit and page.
Number of agents to return per page
20Page number
1A list of agents retrieved successfully.
Invalid query parameters.
Server error while listing agents.
GET /v1/agents HTTP/1.1
Host: api.aver.co
Accept: */*
[
{
"id": "agent_12345",
"name": "MarketAnalyzerAgent",
"description": "Analyzes crypto markets and optimizes trading strategies.",
"functions": "function analyzeMarket(data) { /* ... */ }",
"status": "idle"
}
]Create a new AI agent to be trained and deployed on the Aver platform.
Agent created successfully.
Invalid request body or missing required fields.
Server error while creating agent.
POST /v1/agents HTTP/1.1
Host: api.aver.co
Content-Type: application/json
Accept: */*
Content-Length: 132
{
"name": "MyFirstAgent",
"description": "This agent analyzes crypto markets.",
"functions": "function analyzeMarket(data) { /* ... */ }"
}{
"id": "agent_12345",
"name": "MarketAnalyzerAgent",
"description": "Analyzes crypto markets and optimizes trading strategies.",
"functions": "function analyzeMarket(data) { /* ... */ }",
"status": "idle"
}Retrieve details of a specific agent by its unique ID.
The unique identifier of the agent.
Agent details retrieved successfully.
Agent not found.
Server error while fetching the agent.
GET /v1/agents/{id} HTTP/1.1
Host: api.aver.co
Accept: */*
{
"id": "agent_12345",
"name": "MarketAnalyzerAgent",
"description": "Analyzes crypto markets and optimizes trading strategies.",
"functions": "function analyzeMarket(data) { /* ... */ }",
"status": "idle"
}Update the metadata of an existing agent. You can edit the name, description, or associated functions.
The unique identifier of the agent.
Agent updated successfully.
Invalid request body.
Agent not found.
Server error while updating agent.
PATCH /v1/agents/{id} HTTP/1.1
Host: api.aver.co
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"name": "text",
"description": "text",
"functions": "text"
}{
"id": "agent_12345",
"name": "MarketAnalyzerAgent",
"description": "Analyzes crypto markets and optimizes trading strategies.",
"functions": "function analyzeMarket(data) { /* ... */ }",
"status": "idle"
}Permanently remove an agent from the platform by ID.
The unique identifier of the agent.
Agent deleted successfully. No content in response.
No content
Agent not found.
Server error while deleting agent.
DELETE /v1/agents/{id} HTTP/1.1
Host: api.aver.co
Accept: */*
No content
Initiate the training process for a specific agent using provided data or parameters.
The unique identifier of the agent to train.
Location or references to the training dataset.
Hyperparameter configurations for the training process.
Training process accepted. The status can be polled.
Invalid training data.
Agent not found.
Server error while initiating training.
POST /v1/agents/{id}/train HTTP/1.1
Host: api.aver.co
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"trainingData": "text",
"hyperparameters": {}
}{
"agentId": "text",
"status": "in-progress",
"progress": 45
}Retrieve the current status (in-progress, completed, failed) of an agent's training.
The unique identifier of the agent.
Training status retrieved successfully.
Agent not found.
Server error while fetching training status.
GET /v1/agents/{id}/train/status HTTP/1.1
Host: api.aver.co
Accept: */*
{
"agentId": "text",
"status": "in-progress",
"progress": 45
}Deploy a trained agent to the blockchain or a supported environment for live usage.
The unique identifier of the agent.
Agent deployed successfully.
The agent is not fully trained or is in an invalid state.
Agent not found.
Server error during deployment.
POST /v1/agents/{id}/deploy HTTP/1.1
Host: api.aver.co
Accept: */*
{
"agentId": "text",
"deploymentId": "text",
"message": "Agent successfully deployed to mainnet."
}Fetch the logs generated by a deployed agent, including any blockchain interactions or function calls.
The unique identifier of the agent.
Limit the number of log entries.
50Logs retrieved successfully.
Agent not found or no logs available.
Server error while retrieving logs.
GET /v1/agents/{id}/logs HTTP/1.1
Host: api.aver.co
Accept: */*
[
{
"timestamp": "2025-01-06T12:34:56Z",
"message": "Agent executed function analyzeMarket"
}
]Run one of the agent’s associated functions with your specified input data.
The unique identifier of the agent.
Name of the function to execute.
Any data required by the function.
Function executed successfully.
Invalid function call or input data.
Agent or function not found.
Server error while executing the function.
POST /v1/agents/{id}/execute HTTP/1.1
Host: api.aver.co
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"functionName": "text",
"inputData": {}
}{
"result": {},
"message": "Function executed successfully."
}Last updated