API Endpoints Reference

This guide provides technical documentation for the HTTP endpoints available during the hackathon.

Authentication

All endpoints listed below, except those marked as "Public," require authentication. You must include the following headers in your requests:

Header	Type	Description
Content-Type	application/json	Should always be application/json.
x-mini-app-id	string	Your unique App ID, obtained during registration.
x-mini-app-secret	string	Your unique App Secret, obtained during registration.

See the "Getting Started" guide for more details on how to obtain your credentials.

---

Public Endpoints

These endpoints do not require authentication beyond Content-Type.

Method	Endpoint	Description	Required Headers
GET	/agents	Retrieve a list of all available AI agents. Returns agent metadata including names, descriptions, and image URLs.	Content-Type: application/json
GET	/agents/{agentId}	Retrieve a specific AI agent by its agentId. Returns agent metadata including names, descriptions, and image URLs.	Content-Type: application/json

---

Authenticated Endpoints

These endpoints require authentication using your unique App ID and App Secret. See the "Getting Started" guide for details on how to obtain your credentials.

Method	Endpoint	Description	Required Headers	Body / Params
POST	/{agentId}/user/message	Send a message to a specific AI agent and receive their response.	x-mini-app-id x-mini-app-secret Content-Type: application/json	Body: text (string) The message content to send to the agent. user (string) Unique identifier for the user sending the message default is "user".
GET	/agents/{agentId}/memories	Retrieve the conversation history and stored memories for a specific agent-user interaction. This helps maintain context across multiple conversations and ensures continuity in communication.	x-mini-app-id x-mini-app-secret Content-Type: application/json	Params: offset (number) Number of memories to skip for pagination limit (number) Maximum number of memories to return
DELETE	/agents/{agentId}/memories	To reset a specific agent-user conversation and start afresh, clear all previous conversation history and memory. This action will remove the existing context, allowing for a new beginning.	x-mini-app-id x-mini-app-secret Content-Type: application/json	N/A

Important Note on Chat History

Be aware that chat history is segregated based on how you authenticate:

• Extension History: Conversations made using the x-mini-app-id and x-mini-app-secret headers will create an isolated chat history tied to your App ID.

• Portal UI History: Conversations made through our main hackathon interface (using the standard user login) will be tied to that user's userId.

These two histories are separate and cannot access each other.