diff --git a/pages/apis/agentverse/mailroom.mdx b/pages/apis/agentverse/mailroom.mdx index d0bee29e1..a85aff466 100644 --- a/pages/apis/agentverse/mailroom.mdx +++ b/pages/apis/agentverse/mailroom.mdx @@ -19,72 +19,18 @@ import { # Mailroom API
- Welcome to the Mailroom API documentation. -
- -## Overview - - - - The mailroom API allows you to interact and manage the mailroom service offered by the Agentverse. This involves exploring and deleting - mailroom envelopes, managing agent registration for the mailroom service and monitoring your agents mailroom usage. - - - ```bash filename="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 + The Mailroom API streamlines communication by providing a dedicated [Mailbox ↗️](/guides/agents/intermediate/mailbox) for Agents in Agentverse; it ensures that Agents can send and receive messages even when offline, behind firewalls, or unable to maintain a constant network connection. - GET /v1/profile/usage - ``` - +Key functionalities include: - +- **Agent management**: register, retrieve, update, and delete Agent details. +- **Message handling**: store messages for offline Agents, enabling them to access and process them when back online. +- **Usage monitoring**: track data transfer, message volume, and storage limits for efficient resource management. +- **Secure access**: manage API keys to ensure secure and controlled access to Mailroom features. -## Notable Objects - -### The Agent Object - - - - - - The given address of the agent. - - - The name of the Agent. - - - Pending message for an agent in the mailroom. - - - Bytes transferred over the mailroom. - - - Previously transferred bytes. - - - - - ```json filename="Example Agent Object" - { - "name": "Example Name", - "address": "agent1qtw0hy4kj65fv6j7qyv5mgdecq7c4qyqfqnjgc25wz4vf5h47l9l6m7qqtg", - "Pending_messages": 1, - "Bytes_transferred": 1, - "Previous_Bytes_transferred": 1 - } - ``` - - +You can see our dedicated object reference documentation [here ↗️](/references/agentverse/mailroom). + ## Request and response library diff --git a/pages/references.mdx b/pages/references.mdx index 81bf78780..acd9075ea 100644 --- a/pages/references.mdx +++ b/pages/references.mdx @@ -41,6 +41,20 @@ import { AgentsIcon, LedgerIcon , AsiIcon} from "src/icons/main-page-icons" } ] }, + { + type: "Agentverse", + icon: AgentsIcon, + data: [ + { + title: "Almanac API Objects", + path: "/references/agentverse/alamanc", + }, + { + title: "Mailroom API Objects", + path: "/references/agentverse/mailroom", + } + ] + }, { type: "Ledger", icon: LedgerIcon, diff --git a/pages/references/agentverse/_meta.json b/pages/references/agentverse/_meta.json index ccd0a56f2..edbbaa7c4 100644 --- a/pages/references/agentverse/_meta.json +++ b/pages/references/agentverse/_meta.json @@ -10,5 +10,9 @@ "search": { "title": "Search API", "timestamp": true + }, + "mailroom": { + "title": "Mailroom API", + "timestamp": true } } diff --git a/pages/references/agentverse/alamanc.mdx b/pages/references/agentverse/alamanc.mdx index b4de9dad2..023aed839 100644 --- a/pages/references/agentverse/alamanc.mdx +++ b/pages/references/agentverse/alamanc.mdx @@ -5,7 +5,7 @@ import { import { Row, Col } from "../../../components/mdx"; -# Almanac API +# Almanac API Objects
Welcome to the Almanac API documentation. diff --git a/pages/references/agentverse/mailroom.mdx b/pages/references/agentverse/mailroom.mdx new file mode 100644 index 000000000..adacfc544 --- /dev/null +++ b/pages/references/agentverse/mailroom.mdx @@ -0,0 +1,71 @@ +import { + Properties, + Property +} from "../../../components/mdx"; + +import { Row, Col } from "../../../components/mdx"; + +# 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 ↗️](/guides/agents/intermediate/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. + + + ```bash filename="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 + + + + + + The given address of the agent. + + + The name of the Agent. + + + Pending message for an agent in the mailroom. + + + Bytes transferred over the mailroom. + + + Previously transferred bytes. + + + + + ```json filename="Example Agent Object" + { + "name": "Example Name", + "address": "agent1qtw0hy4kj65fv6j7qyv5mgdecq7c4qyqfqnjgc25wz4vf5h47l9l6m7qqtg", + "Pending_messages": 1, + "Bytes_transferred": 1, + "Previous_Bytes_transferred": 1 + } + ``` + +