Skip to content

Commit f65ed2a

Browse files
chore(docs): revert almanac apis changes (#1121)
1 parent 1458ca7 commit f65ed2a

File tree

1 file changed

+120
-2
lines changed

1 file changed

+120
-2
lines changed

pages/apis/agentverse/almanac.mdx

+120-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,130 @@
1+
import {
2+
Note,
3+
Properties,
4+
Property,
5+
Warn,
6+
Section,
7+
ApiIntro,
8+
Tag,
9+
CodeHeading,
10+
} from "../../../components/mdx";
11+
import { DropDownTabs, Tab } from "../../../components/mdx";
12+
import { Row, Col } from "../../../components/mdx";
113
import {
214
ApiEndpointRequestResponse,
315
} from "../../../components/api-endpoint";
416

517
# Almanac API
618

7-
some into about it.
19+
<div className="nx-text-fetch-content">
20+
Welcome to the Almanac API documentation.
21+
</div>
22+
23+
## Overview
24+
25+
<Row>
26+
<Col>
27+
The Almanac API allows you to manage your agents that are hosted by Agentverse. This involves searching for and registering
28+
agents, updating the manifests of existing agents, checking Agent name availability and getting as well as updating Agent manifests.
29+
</Col>
30+
<Col>
31+
```bash filename="Endpoints"
32+
GET /v1/almanac/recent
33+
POST /v1/almanac/search
34+
35+
GET /v1/almanac/agents/:address
36+
GET /v1/almanac/search/available_name
37+
38+
GET /v1/almanac/manifests/protocols/:protocol_digest
39+
GET /v1/almanac/manifests/models/:model_digest
40+
```
41+
</Col>
42+
43+
</Row>
44+
45+
## Notable Objects
46+
47+
### The Agent Object
48+
49+
<Row>
50+
<Col>
51+
<Properties>
52+
<Property name="status" type="string">
53+
The given address of the agent.
54+
</Property>
55+
<Property name="address" type="string">
56+
The domain name associated with an address.
57+
</Property>
58+
<Property name="Endpoints" type="array">
59+
The endpoints and their associated weights for an agent.
60+
</Property>
61+
<Property name="Protocol" type="array">
62+
Protocol digests associated with an Agent.
63+
</Property>
64+
<Property name="Expiry" type="string" format="date-time">
65+
The Almanac registration expiration.
66+
</Property>
67+
</Properties>
68+
</Col>
69+
<Col>
70+
```json filename="Sample Agent Object"
71+
{
72+
"status": "Active",
73+
"address": "agent1qwckmey38jd6xl6al9k5qcelr9faqfgpxh73tev6fa3ruqnzajp6yneg3qw",
74+
"endpoints": [{"url": "https://agentverse.ai/v1/hosting/submit", "weight": 1}],
75+
"protocol": "a98290009c0891bc431c5159357074527d10eff6b2e86a61fcf7721b472f1125",
76+
"expiry": "2023-08-26T03:30:05.568195+00:00"
77+
}
78+
```
79+
</Col>
80+
</Row>
81+
82+
### The AgentNameAvailability Object
83+
84+
<Row>
85+
<Col>
86+
<Properties>
87+
<Property name="name_prefix" type="string">
88+
The prefix for the Agent's name.
89+
</Property>
90+
<Property name="domain" type="string">
91+
The Agent's domain.
92+
</Property>
93+
<Property name="status" type="string">
94+
The status of the AgentNameAvailability object i.e reserved or available.
95+
</Property>
96+
</Properties>
97+
</Col>
98+
<Col>
99+
```json filename="Sample AgentNameAvailability Object"
100+
{
101+
"name_prefix": "Example Name",
102+
"domain": ".agent",
103+
"Status": "Available"
104+
}
105+
```
106+
</Col>
107+
</Row>
108+
109+
### The AgentNameAvailabilityStatus Object
110+
111+
<Row>
112+
<Col>
113+
<Properties>
114+
<Property name="AgentNameAvailability" type="string">
115+
Enumerated as reserved or available.
116+
</Property>
117+
</Properties>
118+
</Col>
119+
<Col>
120+
```json filename="Sample AgentNameAvailabilityStatus Object"
121+
{
122+
"AgentNameAvailabilityStatus": "Enumeration": "Available"
123+
}
124+
```
125+
</Col>
126+
</Row>
8127

9-
You can see our object reference documentation [here]()
10128
## Request and response library
11129

12130
### Get Recently Registered Agents

0 commit comments

Comments
 (0)