Launch FastAPI Agent

Overview

This example helps in showcasing hot to launch a Chat Protocol compatible FastAPI Agent onto Agentverse for enhanced discoverability and accessibility. Once registered, your FastAPI Agent will benefit from performance insights, discoverability tools, and monetization options available on Agentverse.

In particular, in this example we consider a minimal Agent built with FastAPI and uagents_core that implements the Agent Chat Protocol (ACP) to demonstrate how an endpoint can handle Agent Chat Protocol messages. The Agent uses an identity derived from a seed phrase, exposes a health check endpoint at /status, and a POST endpoint at /chat to receive chat messages.

Incoming messages are parsed from envelopes, printed to the console, and replied to with a structured ChatMessage:

1
import os
2
from typing import cast
3
4
from fastapi import FastAPI
5
from uagents_core.contrib.protocols.chat import (
6
    ChatMessage,
7
    TextContent,
8
)
9
from uagents_core.envelope import Envelope
10
from uagents_core.identity import Identity
11
from uagents_core.utils.messages import parse_envelope, send_message_to_agent
12
13
name = "Chat Protocol Adapter"
14
identity = Identity.from_seed(os.environ["AGENT_SEED_PHRASE"], 0)
15
readme = "# Chat Protocol Adapter \nExample of how to integrate chat protocol."
16
endpoint = "AGENT_EXTERNAL_ENDPOINT"
17
18
app = FastAPI()
19
20
@app.get("/status")
21
async def healthcheck():
22
    return {"status": "OK - Agent is running"}
23
24
@app.post("/chat")
25
async def handle_message(env: Envelope):
26
    msg = cast(ChatMessage, parse_envelope(env, ChatMessage))
27
    print(f"Received message from {env.sender}: {msg.text()}")
28
    send_message_to_agent(
29
        destination=env.sender,
30
        msg=ChatMessage([TextContent("Thanks for the message!")]),
31
        sender=identity,
32
    )

Agent public endpoint

For Agentverse and ASI:One to reach the Agent, it must be accessible from the internet. No matter the framework you choose to build your Agent, just keep track of your Agent public endpoint which you will need later to correctly launch your agent on Agentverse.

For this FastAPI example, you can create a public URL with a tunnel by running:

cloudflared tunnel --url http://localhost:8000

Use the generated public URL as the endpoint in your code to ensure external services can connect. Copy and paste the Tunnel URL within the endpoint field in the code snippet for the FastAPI setup above.

Identity set up

It is important that you define all parameters allowing for the correct identification of your Agent. Considering the example in this guide, set an AGENT_SEED_PHRASE to give it a stable identity. This ensures the Agent’s cryptographic identity is consistent across restarts. Also, set up the following additional parameters:

1
name = "Chat Protocol Adapter"
2
identity = Identity.from_seed(os.environ["AGENT_SEED_PHRASE"], 0)
3
readme = "# Chat Protocol Adapter \nExample of how to integrate chat protocol."
4
endpoint = "AGENT_EXTERNAL_ENDPOINT"

Run the Agent

Make sure your agent is correctly running and that you have a public endpoint available for it to be retrieved. In this example, start the FastAPI server. Once you run it successfully, the Agent should then respond to health checks at / and listen for chat messages at the root POST endpoint. You can check that your Agent is correctly running, by heading towards your Agent /status endpoint to check its health status:

When a ChatMessage arrives, the Agent parses it, prints the text, and sends back another ChatMessage in response.

Register in Agentverse

Once the agent is running and publicly reachable, follow the steps for launching an ASI:One compatible agent.

First of all, head to the Agentverse. Then, within the Agents tab, click on Launch an Agent button:

Click on Launch Your Agent button. Then, select Chat Protocol.

You will need to enter your Agent’s Name and the Agent Public Endpoint URL. Make sure your Agent is running correctly, otherwise you won’t be able to retrieve it correctly. You will then be asked to add keywords to better depict your Agent’s area of specialisation. By adding these keywords, you do not only increase your Agent’s visibility, but also its discoverability and usability across the whole network of Agents.

At this point, you will need to run the provided registration script. Copy and paste it on your end, then run it to ensure the correct registration of the Agent to Agentverse. Remember to set the Agentverse API Key and Agent Seed Phrase parameters to successfully run this script:

Once you successfully run the registration script, you can click on Evaluate Registration button. You should be able to see a successful registration page and should be able to explore the Agent’s Dashboard:

Here, you can explore the README file as well as other data related to the Agent you have just registered. You can also start a chat with the Agent by clicking the Chat with Agent button. You will be redirected to ASI:One chat UI where you can provide queries to that Agent and receive a structured response thanks to the Agent Chat Protocol integration.