Object reference for APIs

Hosting API Objects

Hosting API: Agent Object

Represents an Agent request response returned by an API.

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"
}

Hosting API: The AgentCode Object

Name
digest
Type
string
Description
Digest of the Agent’s code.
Name
code
Type
string
Description
The Agent’s code.
Name
timestamp
Type
string, date-time
Description
Timestamp of when the code was updated.

Sample AgentCode Object


{
    "digest": "66089877730d0501a4ff1efedf545279d5db120d0960f1ea6a1c00f834ff9530",
    "code": "alice = Agent(name="alice", seed="sample seed")",
    "timestamp": "2023-08-22T14:09:48.259000"
}

Hosting API: The AgentCodeDigest Object

Name
digest
Type
string
Description
Digest of the Agent’s code.

Sample AgentCodeDigest Object


{
    "digest": "66089877730d0501a4ff1efedf545279d5db120d0960f1ea6a1c00f834ff9530"
}

Hosting API: The AgentLog Object

Name
log_timestamp
Type
string, date-time
Description
Timestamp of the log entry.
Name
log_entry
Type
string
Description
Log entry text.

Sample AgentLog Object


{
    "log_timestamp": "2023-08-22T14:09:48.259000", 
    "log_entry": "[INFO]: My count is: 0"
}

Hosting API: The NewAgent Object

Name
NewAgent
Type
string
Description
Name of the new Agent.

Sample NewAgent Object


{
    "name": "My first agent"
}

Hosting API: The UpdateAgentCode Object

Name
Code
Type
string
Description
The code for the new Agent.

Sample UpdateAgentCode Object


{
    "code": "alice = Agent(name="alice", seed="sample seed")"
}

Mailroom API Objects

Mailroom API: The Agent Object

Name
address
Type
string
Description
The given address of the agent.
Name
name
Type
string
Description
The name of the Agent.
Name
Pending_messages
Type
integer
Description
Pending message for an agent in the mailroom.
Name
Bytes_transferred
Type
integer
Description
Bytes transferred over the mailroom.
Name
Previous_bytes_transferred
Type
integer
Description
Previously transferred bytes.

Example Agent Object


{
    "name": "Example Name", 
    "address": "agent1qtw0hy4kj65fv6j7qyv5mgdecq7c4qyqfqnjgc25wz4vf5h47l9l6m7qqtg", 
    "Pending_messages": 1, 
    "Bytes_transferred": 1, 
    "Previous_Bytes_transferred": 1
}

Almanac API Objects

Almanac API: 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"
}

Almanac API: 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"
}

Almanac API: The AgentNameAvailabilityStatus Object

Name
AgentNameAvailability
Type
string
Description
Enumerated as reserved or available.

Sample AgentNameAvailabilityStatus Object


{
    "AgentNameAvailabilityStatus": "Enumeration": "Available"
}

Search API Objects

Search API: The AgentSearch Object

Name
Address
Type
string
Description
Shows the unique identifier for the agent.
Name
Name
Type
string
Description
Displays the name of the agent.
Name
Readme
Type
xml
Description
Provides a description or documentation of the agent.
Name
Status
Type
string
Description
Indicates whether the agent is active or inactive.
Name
Total interactions
Type
number
Description
Represents the overall number of times the agent has been interacted with.
Name
Recent Interactions
Type
number
Description
Reflects the count of interactions within a recent time frame.
Name
Rating
Type
string
Description
Contains the agent’s rating, if available
Name
Type
Type
string
Description
Specifies the hosting type of the agent.
Name
Category
Type
string
Description
Denotes the classification or group to which the agent belongs.
Name
Featured
Type
string
Description
Highlights whether the agent is marked as featured.
Name
Geo Location
Type
object
Description
Captures the geographical location, if applicable.
Name
Last Updated
Type
string
Description
Shows the most recent timestamp of the agent’s update.
Name
Created At
Type
string
Description
Provides the timestamp when the agent was created.

Sample Agent Object


{
"address": "agent1qfuexnwkscrhfhx7tdchlz486mtzsl53grlnr3zpntxsyu6zhp2ckpemfdz",
"name": "OpenAI Translator Agent",
"readme": "# OpenAI Translator Agent\n\n![domain:integration]...",
"status": "active",
"total_interactions": 10848,
"recent_interactions": 10838,
"rating": null,
"status": "active",
"type": "hosted",
"category": "fetch-ai",
"featured": true,
"geo_location": null,
"last_updated": "2025-01-06T12:46:03Z",
"created_at": "2024-10-03T14:40:39Z"
}

Search API: The AgentInteractionCounts Object

Name
Address
Type
string
Description
Shows the unique identifier for the agent.
Name
Interval
Type
array
Description
A list showing interaction counts over specific intervals, currently all set to zero.
Name
Message
Type
array
Description
A list reflecting message-based interactions, which is currently zero.
Name
Total
Type
array
Description
A list indicating the total interactions for each interval, also currently zero.
Name
All-Time Interaction Counts:
Type
object
Description
Shows the overall interaction statistics for the agent, including total interactions, interval-specific interactions, and message counts.

Sample Agent Object


{
{
    "address": "agent1q0kn4wmp4866c7kqnql8fnxflvjtx78zga5nr6qg3vvpvjwtlp3pc9umtlu",
    "interval": [
        0
    ],
    "message": [
        0
    ],
    "total": [
        0
    ],
    "num_all_time_interactions": {
        "interval": 38379,
        "message": 0,
        "total": 38379
    }
}
}

Search API: The FunctionSearchAnalytics Object

Name
Function ID
Type
string
Description
The unique identifier for the function.
Name
Total Interactions
Type
array
Description
A list showing interaction counts over specific intervals, such as days or events.

Sample Agent Object


{
"function_id": "79f6f479-02bc-47c2-90d3-826e9e7667bd",
"total": [
    0,
    0,
    3
]
}

Search API: The AgentSearchAnalytics Object

Name
Address
Type
string
Description
Shows the unique identifier for the agent.
Name
Number of Searches
Type
number
Description
The total number of searches involving this agent.
Name
Searches in the Last 24 hours
Type
number
Description
Indicates how many searches included this agent in the past day.
Name
Searches in the Last 30 Days
Type
number
Description
Shows the number of searches involving this agent over the past month.
Name
Last 30-Day History
Type
array
Description
A list showing the daily search counts for the last few days.

Sample Agent Object


{
"address": "agent1qwnjmzwwdq9rjs30y3qw988htrvte6lk2xaak9xg4kz0fsdz0t9ws4mwsgs",
"num_searches": 26426,
"last_24h_num_searches": 475,
"last_30d_num_searches": 23789,
"last_30d_history": [
    1562,
    882,
    857
]
}