diff --git a/pages/apis/agentverse/almanac.mdx b/pages/apis/agentverse/almanac.mdx index fc35a8121..a90fb1c01 100644 --- a/pages/apis/agentverse/almanac.mdx +++ b/pages/apis/agentverse/almanac.mdx @@ -1,12 +1,130 @@ +import { + Note, + Properties, + Property, + Warn, + Section, + ApiIntro, + Tag, + CodeHeading, +} from "../../../components/mdx"; +import { DropDownTabs, Tab } from "../../../components/mdx"; +import { Row, Col } from "../../../components/mdx"; import { ApiEndpointRequestResponse, } from "../../../components/api-endpoint"; # Almanac API -some into about it. +
+ Welcome to the Almanac API documentation. +
+ +## Overview + + + + The Almanac API allows you to manage your agents that are hosted by Agentverse. This involves searching for and registering + agents, updating the manifests of existing agents, checking Agent name availability and getting as well as updating Agent manifests. + + + ```bash filename="Endpoints" + GET /v1/almanac/recent + POST /v1/almanac/search + + GET /v1/almanac/agents/:address + GET /v1/almanac/search/available_name + + GET /v1/almanac/manifests/protocols/:protocol_digest + GET /v1/almanac/manifests/models/:model_digest + ``` + + + + +## Notable Objects + +### The Agent Object + + + + + + The given address of the agent. + + + The domain name associated with an address. + + + The endpoints and their associated weights for an agent. + + + Protocol digests associated with an Agent. + + + The Almanac registration expiration. + + + + + ```json filename="Sample Agent Object" + { + "status": "Active", + "address": "agent1qwckmey38jd6xl6al9k5qcelr9faqfgpxh73tev6fa3ruqnzajp6yneg3qw", + "endpoints": [{"url": "https://agentverse.ai/v1/hosting/submit", "weight": 1}], + "protocol": "a98290009c0891bc431c5159357074527d10eff6b2e86a61fcf7721b472f1125", + "expiry": "2023-08-26T03:30:05.568195+00:00" + } + ``` + + + +### The AgentNameAvailability Object + + + + + + The prefix for the Agent's name. + + + The Agent's domain. + + + The status of the AgentNameAvailability object i.e reserved or available. + + + + + ```json filename="Sample AgentNameAvailability Object" + { + "name_prefix": "Example Name", + "domain": ".agent", + "Status": "Available" + } + ``` + + + +### The AgentNameAvailabilityStatus Object + + + + + + Enumerated as reserved or available. + + + + + ```json filename="Sample AgentNameAvailabilityStatus Object" + { + "AgentNameAvailabilityStatus": "Enumeration": "Available" + } + ``` + + -You can see our object reference documentation [here]() ## Request and response library ### Get Recently Registered Agents