Skip to main content
Use Integrate Aomi when you want to call Aomi from an existing product or service with TypeScript or raw HTTP. Use Try Aomi for the no-code surfaces (Portal, skills, MCP, CLI), and Build on Aomi when you want to create and deploy a new App. @aomi-labs/client works in Node.js and browsers. The Aomi class gives you five surfaces:
On September 22, 2026, npm’s latest was @aomi-labs/client 0.7.6; merged source was 0.9.4. The quickstart, device OAuth, routing, credits, and EVM/SVM Pipeline examples type-check against 0.7.6. The App credential helpers and durable Commit examples describe newer merged source and require a compatible build and deployment. A source version does not mean that version is published.

Check compatibility

Keep the installed package and API environment aligned:
The production origin is https://chat.aomi.dev. Its published OpenAPI lists the versioned Agent and Pipeline routes, but a listed route does not guarantee that the environment implements every contract on main. The newer account credential and durable Commit APIs require a matching package and deployment. Select an environment that explicitly supports the feature you use; do not combine portable Builds from incompatible versions. These guides describe merged contracts only. Open pull requests are not part of the supported examples.

Quickstart

Create a working Node.js integration in one file. Guest mode does not need an API key or OAuth client.
Add a TypeScript runner if your project does not already have one:
Set the API origin supplied for your environment:

Run two Agent turns

Reusing sessionId continues the same conversation. Persist that ID with your application’s conversation record. Run it with your TypeScript runner:
No API key is needed — the SDK starts in guest mode, creating an anonymous session on the first request.
Guest mode is useful for evaluation, not a substitute for service authentication. For account-owned sessions or protected actions, use the OAuth device flow. For a browser product, use Widget authentication or your provisioned browser OAuth flow.

Integration layer

The Aomi facade is the product-level layer: it manages guest or OAuth state, validates arguments against live schemas, wires your wallet capabilities into Agent runs, and shapes responses into typed product objects like AgentRun and Build. Beneath it sits AomiClient, the wire-close layer: one typed method per versioned API operation, with errors normalized and mutation headers applied, but no product behavior added. Both layers share authentication state — aomi.raw is the same AomiClient with the same guest session or OAuth grants — so you can drop down for a single direct call without constructing a second client or authenticating twice.

Next steps

Agent API

Observe progress, manage sessions, interrupt work, and handle actions.

Pipeline API

Discover live operations and keep simulation separate from commit.

Authentication

Start as a guest or add OAuth for account-owned access.

Wallet and signing

Keep wallet review and execution inside your application.
Last modified on September 2, 2026