Agents

Agents are AI-driven entities you can create, train, and deploy. They analyze data, execute tasks, and adapt in real time.

List all agents

get

Retrieve a paginated list of all AI agents, with optional filters for limit and page.

Query parameters

limitintegerOptional

Number of agents to return per page

Default: 20

pageintegerOptional

Page number

Default: 1

Responses

200

A list of agents retrieved successfully.

application/json

400

Invalid query parameters.

500

Server error while listing agents.

get

/agents

HTTPcURLJavaScriptPython

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 an agent

post

Create a new AI agent to be trained and deployed on the Aver platform.

Body

application/json

namestringRequired

descriptionstringOptional

functionsstringOptional

Responses

201

Agent created successfully.

application/json

400

Invalid request body or missing required fields.

500

Server error while creating agent.

post

/agents

HTTPcURLJavaScriptPython

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"
}

Fetch agent by ID

get

Retrieve details of a specific agent by its unique ID.

Path parameters

idstringRequired

The unique identifier of the agent.

Responses

200

Agent details retrieved successfully.

application/json

404

Agent not found.

500

Server error while fetching the agent.

get

/agents/{id}

HTTPcURLJavaScriptPython

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 an agent

patch

Update the metadata of an existing agent. You can edit the name, description, or associated functions.

Path parameters

idstringRequired

The unique identifier of the agent.

Body

application/json

namestringOptional

descriptionstringOptional

functionsstringOptional

Responses

200

Agent updated successfully.

application/json

400

Invalid request body.

404

Agent not found.

500

Server error while updating agent.

patch

/agents/{id}

HTTPcURLJavaScriptPython

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"
}

Delete an agent

delete

Permanently remove an agent from the platform by ID.

Path parameters

idstringRequired

The unique identifier of the agent.

Responses

204

Agent deleted successfully. No content in response.

404

Agent not found.

500

Server error while deleting agent.

delete

/agents/{id}

HTTPcURLJavaScriptPython

DELETE /v1/agents/{id} HTTP/1.1
Host: api.aver.co
Accept: */*

No content

Train an agent

post

Initiate the training process for a specific agent using provided data or parameters.

Path parameters

idstringRequired

The unique identifier of the agent to train.

Body

application/json

trainingDatastringOptional

Location or references to the training dataset.

hyperparametersobjectOptional

Hyperparameter configurations for the training process.

Responses

202

Training process accepted. The status can be polled.

application/json

400

Invalid training data.

404

Agent not found.

500

Server error while initiating training.

post

/agents/{id}/train

HTTPcURLJavaScriptPython

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
}

Get training status

get

Retrieve the current status (in-progress, completed, failed) of an agent's training.

Path parameters

idstringRequired

The unique identifier of the agent.

Responses

200

Training status retrieved successfully.

application/json

404

Agent not found.

500

Server error while fetching training status.

get

/agents/{id}/train/status

HTTPcURLJavaScriptPython

GET /v1/agents/{id}/train/status HTTP/1.1
Host: api.aver.co
Accept: */*

{
  "agentId": "text",
  "status": "in-progress",
  "progress": 45
}

Deploy an agent

post

Deploy a trained agent to the blockchain or a supported environment for live usage.

Path parameters

idstringRequired

The unique identifier of the agent.

Responses

201

Agent deployed successfully.

application/json

400

The agent is not fully trained or is in an invalid state.

404

Agent not found.

500

Server error during deployment.

post

/agents/{id}/deploy

HTTPcURLJavaScriptPython

POST /v1/agents/{id}/deploy HTTP/1.1
Host: api.aver.co
Accept: */*

{
  "agentId": "text",
  "deploymentId": "text",
  "message": "Agent successfully deployed to mainnet."
}

Retrieve agent logs

get

Fetch the logs generated by a deployed agent, including any blockchain interactions or function calls.

Path parameters

idstringRequired

The unique identifier of the agent.

Query parameters

limitintegerOptional

Limit the number of log entries.

Default: 50

Responses

200

Logs retrieved successfully.

application/json

404

Agent not found or no logs available.

500

Server error while retrieving logs.

get

/agents/{id}/logs

HTTPcURLJavaScriptPython

GET /v1/agents/{id}/logs HTTP/1.1
Host: api.aver.co
Accept: */*

[
  {
    "timestamp": "2025-01-06T12:34:56Z",
    "message": "Agent executed function analyzeMarket"
  }
]

Execute a function on the agent

post

Run one of the agent’s associated functions with your specified input data.

Path parameters

idstringRequired

The unique identifier of the agent.

Body

application/json

functionNamestringRequired

Name of the function to execute.

inputDataobjectOptional

Any data required by the function.

Responses

200

Function executed successfully.

application/json

400

Invalid function call or input data.

404

Agent or function not found.

500

Server error while executing the function.

post

/agents/{id}/execute

HTTPcURLJavaScriptPython

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."
}