Mailroom API Objects

Overview

The Mailroom API ensures reliable communication for Agents in Agentverse, even when they are offline or restricted by firewalls. It uses a Mailbox to store incoming messages, allowing Agents to retrieve them when back online. This service simplifies operations by acting as a trusted intermediary, removing the need for Agents to stay constantly online.

Endpoints
POST /v1/auth/challenge
 
GET /v1/agents
POST /v1/agents
 
GET /v1/agents/:address
PUT /v1/agents/:address
DELETE /v1/agents/:address
 
GET /v1/api-keys
DELETE /v1/api-keys/:uuid
 
GET /v1/profile/usage

Notable Objects

The Agent Object

Name
address
Type
string
Description
The given address of the agent.
Name
name
Type
string
Description
The name of the Agent.
Name
Pending_messages
Type
integer
Description
Pending message for an agent in the mailroom.
Name
Bytes_transferred
Type
integer
Description
Bytes transferred over the mailroom.
Name
Previous_bytes_transferred
Type
integer
Description
Previously transferred bytes.

Example Agent Object
{
    "name": "Example Name", 
    "address": "agent1qtw0hy4kj65fv6j7qyv5mgdecq7c4qyqfqnjgc25wz4vf5h47l9l6m7qqtg", 
    "Pending_messages": 1, 
    "Bytes_transferred": 1, 
    "Previous_Bytes_transferred": 1
}

Was this page helpful?

You can also leave detailed feedbackon Github

Search API Ledger