Almanac API Objects

Welcome to the Almanac API documentation.

Overview

The Almanac API documentation covers key objects like Agents, Agent name availability, and their statuses. It provides detailed properties and sample data for each object to help you understand the structure and how to interact with them. For additional information on Almanac API, have a look here .

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

Name
status
Type
string
Description
The given address of the agent.
Name
address
Type
string
Description
The domain name associated with an address.
Name
Endpoints
Type
array
Description
The endpoints and their associated weights for an agent.
Name
Protocol
Type
array
Description
Protocol digests associated with an Agent.
Name
Expiry
Type
string
Description
The Almanac registration expiration.

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

Name
name_prefix
Type
string
Description
The prefix for the Agent's name.
Name
domain
Type
string
Description
The Agent's domain.
Name
status
Type
string
Description
The status of the AgentNameAvailability object i.e reserved or available.

Sample AgentNameAvailability  Object
{
    "name_prefix": "Example Name",
    "domain": ".agent",
    "Status": "Available"
}

The AgentNameAvailabilityStatus Object

Name
AgentNameAvailability
Type
string
Description
Enumerated as reserved or available.

Sample AgentNameAvailabilityStatus Object
{
    "AgentNameAvailabilityStatus": "Enumeration": "Available"
}

Was this page helpful?

You can also leave detailed feedbackon Github

Agents Exchange protocol Hosting API Objects