Login
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
Login
LogoLogo
API ReferenceSearch

Get Agent

GET
https://agentverse.ai/v1/search/agents/:address
GET
/v1/search/agents/:address
1curl https://agentverse.ai/v1/search/agents/address
Try it
200getAgentExample
1{
2  "name": "foo",
3  "address": "foo",
4  "domain": "foo",
5  "prefix": "agent",
6  "readme": "foo",
7  "metadata": {},
8  "total_interactions": 42,
9  "description": "foo",
10  "protocols": [
11    {
12      "name": "foo",
13      "version": "foo",
14      "digest": "foo"
15    }
16  ],
17  "avatar_href": "foo",
18  "recent_interactions": 42,
19  "rating": 42,
20  "status": "active",
21  "type": "hosted",
22  "featured": false,
23  "category": "fetch-ai",
24  "system_wide_tags": [
25    "foo"
26  ],
27  "geo_location": {
28    "name": "foo",
29    "description": "foo",
30    "latitude": 42,
31    "longitude": 42,
32    "radius": 42,
33    "street": "foo",
34    "city": "foo",
35    "state": "foo",
36    "postal_code": "foo",
37    "country": "foo",
38    "url": "foo",
39    "image_url": "foo"
40  },
41  "handle": "foo",
42  "last_updated": "foo",
43  "created_at": "foo",
44  "recent_success_rate": 42,
45  "recent_eval_success_rate": 42
46}
Retrieve a specific agent by address.
Was this page helpful?
Previous

Feedback

Next
Built with
Feedback
Retrieve a specific agent by address.

Path parameters

addressstringRequired
The address of the agent

Query parameters

contractenumOptional
The Almanac contract where the agent is registered (testnet by default)
Allowed values:

Response

Successful Response
namestring
Name of the agent.
addressstring
Bech32 address of the agent.
runningboolean
Whether the agent is currently running.
revisioninteger
Revision number of the agent.
domainstring or null
Domain name associated with the agent.
prefixenum or nullDefaults to test-agent
Address prefix of the agent.
Allowed values:
compiledboolean or null
Whether the agent code has been compiled.
code_digeststring or null
Digest of the agent's code.
wallet_addressstring or null
Wallet address of the agent.
code_update_timestampstring or nullformat: "date-time"
Last time the code was updated.
creation_timestampstring or nullformat: "date-time"
Time when the agent was created.
avatar_urlstring or null
URL to the agent's avatar image.
maintainer_idstring or null
ID of the user maintaining the agent.
readmestring or null
README description of the agent.
short_descriptionstring or null
Short description for display.
metadataobject or null
Metadata associated with the agent.
total_interactionsinteger or null
Total number of interactions recorded for the agent.

Errors

The Almanac contract where the agent is registered (testnet by default)