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

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

GEThttps://api.aver.co/v1/agents

Query parameters

Response

200400500

A list of agents retrieved successfully.

Body

application/json

idstring

Example: "agent_12345"

namestring

Example: "MarketAnalyzerAgent"

descriptionstring

Example: "Analyzes crypto markets and optimizes trading strategies."

functionsstring

Example: "function analyzeMarket(data) { /* ... */ }"

statusstring

Current status of the agent (idle, training, deployed).

Example: "idle"

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/agents', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "agent_12345",
    "name": "MarketAnalyzerAgent",
    "description": "Analyzes crypto markets and optimizes trading strategies.",
    "functions": "function analyzeMarket(data) { /* ... */ }",
    "status": "idle"
  }
]

Create an agent

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

POSThttps://api.aver.co/v1/agents

Body

application/json

name*string

descriptionstring

functionsstring

Response

201400500

Agent created successfully.

Body

application/json

idstring

Example: "agent_12345"

namestring

Example: "MarketAnalyzerAgent"

descriptionstring

Example: "Analyzes crypto markets and optimizes trading strategies."

functionsstring

Example: "function analyzeMarket(data) { /* ... */ }"

statusstring

Current status of the agent (idle, training, deployed).

Example: "idle"

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/agents', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "MyFirstAgent",
      "description": "<p>This agent analyzes crypto markets.</p>",
      "functions": "function analyzeMarket(data) { /* ... */ }",
      "__$markdownParsed": true
    }),
});
const data = await response.json();

Response

201

{
  "id": "agent_12345",
  "name": "MarketAnalyzerAgent",
  "description": "Analyzes crypto markets and optimizes trading strategies.",
  "functions": "function analyzeMarket(data) { /* ... */ }",
  "status": "idle"
}

Fetch agent by ID

Retrieve details of a specific agent by its unique ID.

GEThttps://api.aver.co/v1/agents/{id}

Path parameters

id*string

The unique identifier of the agent.

Response

200404500

Agent details retrieved successfully.

Body

application/json

idstring

Example: "agent_12345"

namestring

Example: "MarketAnalyzerAgent"

descriptionstring

Example: "Analyzes crypto markets and optimizes trading strategies."

functionsstring

Example: "function analyzeMarket(data) { /* ... */ }"

statusstring

Current status of the agent (idle, training, deployed).

Example: "idle"

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/agents/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "agent_12345",
  "name": "MarketAnalyzerAgent",
  "description": "Analyzes crypto markets and optimizes trading strategies.",
  "functions": "function analyzeMarket(data) { /* ... */ }",
  "status": "idle"
}

Update an agent

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

PATCHhttps://api.aver.co/v1/agents/{id}

Path parameters

id*string

The unique identifier of the agent.

Body

application/json

namestring

descriptionstring

functionsstring

Response

200400404500

Agent updated successfully.

Body

application/json

idstring

Example: "agent_12345"

namestring

Example: "MarketAnalyzerAgent"

descriptionstring

Example: "Analyzes crypto markets and optimizes trading strategies."

functionsstring

Example: "function analyzeMarket(data) { /* ... */ }"

statusstring

Current status of the agent (idle, training, deployed).

Example: "idle"

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/agents/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "agent_12345",
  "name": "MarketAnalyzerAgent",
  "description": "Analyzes crypto markets and optimizes trading strategies.",
  "functions": "function analyzeMarket(data) { /* ... */ }",
  "status": "idle"
}

Delete an agent

Permanently remove an agent from the platform by ID.

DELETEhttps://api.aver.co/v1/agents/{id}

Path parameters

id*string

The unique identifier of the agent.

Response

204404500

Agent deleted successfully. No content in response.

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/agents/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Train an agent

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

POSThttps://api.aver.co/v1/agents/{id}/train

Path parameters

id*string

The unique identifier of the agent to train.

Body

application/json

Training data and hyperparameters for the agent.

trainingDatastring

Location or references to the training dataset.

hyperparametersobject

Hyperparameter configurations for the training process.

Response

202400404500

Training process accepted. The status can be polled.

Body

application/json

agentIdstring

statusstring

Current training status (in-progress, completed, failed).

Example: "in-progress"

progressnumber

Training progress in percentage.

Example: 45

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/agents/{id}/train', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

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

Get training status

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

GEThttps://api.aver.co/v1/agents/{id}/train/status

Path parameters

id*string

The unique identifier of the agent.

Response

200404500

Training status retrieved successfully.

Body

application/json

agentIdstring

statusstring

Current training status (in-progress, completed, failed).

Example: "in-progress"

progressnumber

Training progress in percentage.

Example: 45

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/agents/{id}/train/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Deploy an agent

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

POSThttps://api.aver.co/v1/agents/{id}/deploy

Path parameters

id*string

The unique identifier of the agent.

Response

201400404500

Agent deployed successfully.

Body

application/json

agentIdstring

deploymentIdstring

messagestring

Example: "Agent successfully deployed to mainnet."

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/agents/{id}/deploy', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

201

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

Retrieve agent logs

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

GEThttps://api.aver.co/v1/agents/{id}/logs

Path parameters

id*string

The unique identifier of the agent.

Query parameters

Response

200404500

Logs retrieved successfully.

Body

application/json

timestampstring

Example: "2025-01-06T12:34:56Z"

messagestring

Example: "Agent executed function analyzeMarket"

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/agents/{id}/logs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Execute a function on the agent

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

POSThttps://api.aver.co/v1/agents/{id}/execute

Path parameters

id*string

The unique identifier of the agent.

Body

application/json

functionName*string

Name of the function to execute.

inputDataobject

Any data required by the function.

Response

200400404500

Function executed successfully.

Body

application/json

resultobject

Output of the executed function.

messagestring

Example: "Function executed successfully."

Request

JavaScriptCurlPython

const response = await fetch('https://api.aver.co/v1/agents/{id}/execute', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "functionName": "text"
    }),
});
const data = await response.json();

Response

200

{
  "message": "Function executed successfully."
}