Skip to content

Commit

Permalink
docs: generate
Browse files Browse the repository at this point in the history
  • Loading branch information
jrriehl committed Jan 17, 2025
1 parent a758d57 commit f53156c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 19 deletions.
21 changes: 3 additions & 18 deletions python/docs/api/uagents/mailbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,6 @@ Check if the agent is a mailbox agent.

- `bool` - True if the agent is a mailbox agent, False otherwise.

<a id="src.uagents.mailbox.is_proxy_agent"></a>

#### is`_`proxy`_`agent

```python
def is_proxy_agent(endpoints: list[AgentEndpoint],
agentverse: AgentverseConfig) -> bool
```

Check if the agent is a proxy agent.

**Returns**:

- `bool` - True if the agent is a proxy agent, False otherwise.

<a id="src.uagents.mailbox.register_in_agentverse"></a>

#### register`_`in`_`agentverse
Expand All @@ -41,7 +26,6 @@ async def register_in_agentverse(
request: AgentverseConnectRequest,
identity: Identity,
prefix: AddressPrefix,
endpoints: list[AgentEndpoint],
agentverse: AgentverseConfig,
agent_details: Optional[AgentUpdates] = None) -> RegistrationResponse
```
Expand All @@ -52,9 +36,10 @@ Registers agent in Agentverse

- `request` _AgentverseConnectRequest_ - Request object
- `identity` _Identity_ - Agent identity object
- `prefix` _AddressPrefix_ - Agent address prefix - can be "agent" (mainnet) or "test-agent" (testnet)
- `endpoints` _list[AgentEndpoint]_ - Endpoints of the agent
- `prefix` _AddressPrefix_ - Agent address prefix
can be "agent" (mainnet) or "test-agent" (testnet)
- `agentverse` _AgentverseConfig_ - Agentverse configuration
- `agent_details` _Optional[AgentUpdates]_ - Agent details (name, readme, avatar_url)


**Returns**:
Expand Down
3 changes: 2 additions & 1 deletion python/docs/api/uagents/registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ if it is different from the supported version.
#### register

```python
async def register(agent_address: str,
async def register(agent_identifier: str,
identity: Identity,
protocols: List[str],
endpoints: List[AgentEndpoint],
metadata: Optional[Dict[str, Any]] = None)
Expand Down

0 comments on commit f53156c

Please sign in to comment.