Inlay Docs
Publish an agent, integrate it into your product, and inspect production runs.
Build an agent product with your own UI and authentication. Inlay runs the agent graph; your app renders its streaming conversation, outputs, progress, and client-tool interactions.
Access is approved and onboarded manually. Request access on the homepage if you do not have an account yet. These guides do not assume instant signup, public package availability, or a particular commercial plan.
Start here
- Get approved access, select your workspace, and create a server key. Quickstart covers the prerequisites and credential boundary.
- Publish an agent version. Test a draft on the canvas, then make a version live with Versions and publishing.
- Install the SDK and integrate. Follow the available installation paths, mint a user-scoped session on your server, and render the conversation in your app.
- Optionally generate a typed client. Typed clients adds a version-pinned contract and a reproducible CI check once the basic integration works.
Build the product UI
| Task | Guide |
|---|---|
| Render messages, outputs, and tool calls in order | The timeline |
| Bind panels to produced values | Outputs and bindings |
| Keep durable fields and live tables | State and memory |
| Show which node is running | Progress and topology |
| Run app-side tools and approval flows | Client tools |
| Reopen, list, cancel, and start fresh | Conversations |
| Integrate without React | Without React |
| Use Next.js server/client boundaries | Server and shared components |
Extend the agent
| Task | Guide |
|---|---|
| Ground answers in your corpus | Retrieval |
| Use built-in search, fetch, and code execution | Server tools |
| Connect external tools over MCP Streamable HTTP | MCP connectors |
| Store credentials outside the graph | Secrets |
Operate the product
| Task | Guide |
|---|---|
| Inspect runs, activations, and operator-only traces | Observability |
| Handle run failures and HTTP errors | Failure handling |
| Trigger scheduled runs as an end user | Schedules |
| Render your users' plans, wallets, and checkout flows | Billing |
The export-by-export SDK contract lives under API reference.
The shape of it
An agent is a graph you deploy to Inlay. Running one produces a conversation, and a conversation is an ordered list of rows — the user's turns, the assistant's turns, the outputs it produced, and the tools it called.
That list is the primary thing. Everything else the SDK gives you — the chat transcript, a node's live text, the latest value of an output — is a view derived from it, computed once per update rather than filtered on every render.
Three packages cover the integration:
@inlayai/reactprovidesuseInlayChatand the reactive UI hooks.@inlayai/nextmints a session on the server so your secret key never reaches the browser.@inlayai/sdkis the framework-agnostic client underneath, usable directly.
Conventions in these docs
Marked code samples live in projects/inlay/sdk/examples/docs/src. They are
typechecked against the SDK, and a filesystem test checks that the excerpts
match their source. Some excerpts omit imports or application-specific auth;
the surrounding guide names that wiring. Match your SDK and CLI versions to
the release or source revision supplied during onboarding.