Skip to main content
This guide walks through the full-stack integration process, from your existing APIs to a deployed Aomi App that your users can interact with across web, Telegram, and other channels. To work with us on an integration, contact us.

The Pipeline

Each tool wraps one or more of your API endpoints. A one to one mapping is not required. You can aggregate multiple endpoints into a single tool so the LLM’s context stays clean and semantically coherent.

1. Your APIs

Aomi does not modify your APIs. The only requirement is that they are reachable over HTTP. Your backend owns all user state. The Aomi App retains conversation history but nothing about your users, balances, or sessions.
EndpointMethodDescription
/prices/{symbol}GETCurrent token price
/tradesPOSTExecute a trade
/portfolio/{userId}GETUser portfolio and P&L
/marketsGETAvailable trading pairs
/orderbook/{pair}GETOrder book depth

2. Aomi Tool Layer

Aomi wraps your endpoints as tools, typed functions the LLM can invoke during a conversation. Each tool has a name, description, and typed input parameters. Tools can execute concurrently.

3. AomiApp Configuration

Three settings define the App’s behavior: Preamble is the system prompt that shapes the AI’s personality, constraints, and rules. A well written preamble keeps the AI on task and prevents overstepping.
You are the MyCoinDex trading agent. You help users check
prices, manage portfolios, and execute trades.

Always confirm with the user before executing a trade.
Show prices in USD unless the user requests otherwise.
Never provide financial advice or price predictions.
Model Selection offers different models for different needs:
ProviderModels
AnthropicClaude Sonnet, Claude Haiku
OpenAIGPT-4o, GPT-4o Mini
OpenRouterAccess to 100+ models
RAG Document Store: if you have documentation, FAQs, or knowledge base articles, Aomi sets up RAG ingestion. The AI searches these documents when answering questions beyond what tools provide.

4. Deployed App

Aomi compiles and deploys the configured App as an isolated app on the hosted platform. Each app gets a scoped API key and a dedicated chat endpoint.
App:        "mycoindex"
Endpoint:   POST /api/chat?app=mycoindex
Tools:      GetTokenPrice, ExecuteTrade, GetPortfolio, ListMarkets
Preamble:   MyCoinDex trading agent
Model:      Claude Sonnet (default, switchable)

5. Client Integration

PathInstallBest For
Widget (shadcn)npx shadcn add https://aomi.dev/r/aomi-frame.jsonQuick integration, standard chat UI
Headless Librarynpm install @aomi-labs/reactCustom designs, maximum control
Telegram BotManaged by AomiReaching users without frontend deployment

Next Steps

Last modified on June 4, 2026