@21st-sdk/nextjs 0.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 AN Dev (an.dev)
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,88 @@
1
+ # @an-sdk/nextjs
2
+
3
+ Next.js integration for [AN](https://an.dev) AI agent chat. Provides a server-side token handler so your API key never reaches the client.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ npm install @an-sdk/nextjs @an-sdk/react ai @ai-sdk/react
9
+ ```
10
+
11
+ ## Quick Start
12
+
13
+ ### 1. Set your API key
14
+
15
+ ```env
16
+ # .env.local
17
+ AN_API_KEY=an_sk_your_key_here
18
+ ```
19
+
20
+ Get your API key from [an.dev/agents/dashboard/api](https://an.dev/agents/dashboard/api).
21
+
22
+ ### 2. Create the token route (one line)
23
+
24
+ ```ts
25
+ // app/api/an/token/route.ts
26
+ import { createAnTokenHandler } from "@an-sdk/nextjs/server"
27
+
28
+ export const POST = createAnTokenHandler({
29
+ apiKey: process.env.AN_API_KEY!,
30
+ })
31
+ ```
32
+
33
+ ### 3. Use in your page
34
+
35
+ ```tsx
36
+ // app/page.tsx
37
+ "use client"
38
+
39
+ import { useChat } from "@ai-sdk/react"
40
+ import { AnAgentChat, createAnChat } from "@an-sdk/nextjs"
41
+ import "@an-sdk/react/styles.css"
42
+ import { useMemo } from "react"
43
+
44
+ export default function Chat() {
45
+ const chat = useMemo(
46
+ () => createAnChat({
47
+ agent: "your-agent-slug",
48
+ tokenUrl: "/api/an/token",
49
+ }),
50
+ [],
51
+ )
52
+
53
+ const { messages, sendMessage, status, stop, error } = useChat({ chat })
54
+
55
+ return (
56
+ <AnAgentChat
57
+ messages={messages}
58
+ onSend={(msg) =>
59
+ sendMessage({ parts: [{ type: "text", text: msg.content }] })
60
+ }
61
+ status={status}
62
+ onStop={stop}
63
+ error={error}
64
+ />
65
+ )
66
+ }
67
+ ```
68
+
69
+ That's it. Your `an_sk_` API key stays on the server. The client only receives short-lived JWTs.
70
+
71
+ ## How It Works
72
+
73
+ ```
74
+ Browser Your Next.js Server AN Relay
75
+ | | |
76
+ |-- POST /api/an/token --------->| |
77
+ | |-- POST /v1/tokens -------->|
78
+ | | (with an_sk_ key) |
79
+ | |<-- { token, expiresAt } ---|
80
+ |<-- { token, expiresAt } ------| |
81
+ | |
82
+ |-- POST /v1/chat/:agent ------(with short-lived JWT)------->|
83
+ |<-- streaming response -----(SSE)---------------------------|
84
+ ```
85
+
86
+ ## License
87
+
88
+ MIT
package/dist/index.cjs ADDED
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __copyProps = (to, from, except, desc) => {
7
+ if (from && typeof from === "object" || typeof from === "function") {
8
+ for (let key of __getOwnPropNames(from))
9
+ if (!__hasOwnProp.call(to, key) && key !== except)
10
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
11
+ }
12
+ return to;
13
+ };
14
+ var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
15
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
16
+
17
+ // src/index.ts
18
+ var src_exports = {};
19
+ module.exports = __toCommonJS(src_exports);
20
+ __reExport(src_exports, require("@21st-sdk/react"), module.exports);
21
+ // Annotate the CommonJS export names for ESM import in node:
22
+ 0 && (module.exports = {
23
+ ...require("@21st-sdk/react")
24
+ });
25
+ //# sourceMappingURL=index.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["// Re-export everything from @21st-sdk/react for convenience\nexport * from \"@21st-sdk/react\"\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;AAAA;AACA,wBAAc,4BADd;","names":[]}
@@ -0,0 +1 @@
1
+ export * from '@21st-sdk/react';
@@ -0,0 +1 @@
1
+ export * from '@21st-sdk/react';
package/dist/index.js ADDED
@@ -0,0 +1,3 @@
1
+ // src/index.ts
2
+ export * from "@21st-sdk/react";
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["// Re-export everything from @21st-sdk/react for convenience\nexport * from \"@21st-sdk/react\"\n"],"mappings":";AACA,cAAc;","names":[]}
@@ -0,0 +1,71 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __export = (target, all) => {
7
+ for (var name in all)
8
+ __defProp(target, name, { get: all[name], enumerable: true });
9
+ };
10
+ var __copyProps = (to, from, except, desc) => {
11
+ if (from && typeof from === "object" || typeof from === "function") {
12
+ for (let key of __getOwnPropNames(from))
13
+ if (!__hasOwnProp.call(to, key) && key !== except)
14
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
15
+ }
16
+ return to;
17
+ };
18
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
+
20
+ // src/server.ts
21
+ var server_exports = {};
22
+ __export(server_exports, {
23
+ createAnTokenHandler: () => createAnTokenHandler,
24
+ exchangeToken: () => exchangeToken
25
+ });
26
+ module.exports = __toCommonJS(server_exports);
27
+ async function exchangeToken(options) {
28
+ const {
29
+ apiKey,
30
+ relayUrl = "https://relay.an.dev",
31
+ expiresIn = "1h",
32
+ agent,
33
+ userId
34
+ } = options;
35
+ const res = await fetch(`${relayUrl}/v1/tokens`, {
36
+ method: "POST",
37
+ headers: {
38
+ "Content-Type": "application/json",
39
+ Authorization: `Bearer ${apiKey}`
40
+ },
41
+ body: JSON.stringify({
42
+ userId,
43
+ agents: agent ? [agent] : void 0,
44
+ expiresIn
45
+ })
46
+ });
47
+ if (!res.ok) {
48
+ const err = await res.json().catch(() => ({ error: "Failed to exchange token" }));
49
+ throw new Error(err.error || `Token exchange failed: ${res.status}`);
50
+ }
51
+ return res.json();
52
+ }
53
+ function createAnTokenHandler(options) {
54
+ return async function POST(req) {
55
+ try {
56
+ const body = await req.json().catch(() => ({}));
57
+ const { agent, userId } = body;
58
+ const data = await exchangeToken({ ...options, agent, userId });
59
+ return Response.json(data);
60
+ } catch (err) {
61
+ const message = err instanceof Error ? err.message : "Internal error";
62
+ return Response.json({ error: message }, { status: 500 });
63
+ }
64
+ };
65
+ }
66
+ // Annotate the CommonJS export names for ESM import in node:
67
+ 0 && (module.exports = {
68
+ createAnTokenHandler,
69
+ exchangeToken
70
+ });
71
+ //# sourceMappingURL=server.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/server.ts"],"sourcesContent":["export interface TokenHandlerOptions {\n /** Your an_sk_ API key — keep in process.env, never expose to client */\n apiKey: string\n /** Relay URL. Default: \"https://relay.an.dev\" */\n relayUrl?: string\n /** Token expiry. Default: \"1h\" */\n expiresIn?: string\n}\n\nexport interface ExchangeTokenOptions extends TokenHandlerOptions {\n /** Agent slug to scope the token to */\n agent?: string\n /** User identifier for the token */\n userId?: string\n}\n\n/** Exchange an an_sk_ API key for a short-lived JWT via the relay */\nexport async function exchangeToken(options: ExchangeTokenOptions) {\n const {\n apiKey,\n relayUrl = \"https://relay.an.dev\",\n expiresIn = \"1h\",\n agent,\n userId,\n } = options\n\n const res = await fetch(`${relayUrl}/v1/tokens`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n Authorization: `Bearer ${apiKey}`,\n },\n body: JSON.stringify({\n userId,\n agents: agent ? [agent] : undefined,\n expiresIn,\n }),\n })\n\n if (!res.ok) {\n const err = await res.json().catch(() => ({ error: \"Failed to exchange token\" }))\n throw new Error(err.error || `Token exchange failed: ${res.status}`)\n }\n\n return res.json() as Promise<{ token: string; expiresAt: string }>\n}\n\n/** Create a Next.js API route handler that exchanges an_sk_ keys for JWTs */\nexport function createAnTokenHandler(options: TokenHandlerOptions) {\n return async function POST(req: Request) {\n try {\n const body = await req.json().catch(() => ({}))\n const { agent, userId } = body as { agent?: string; userId?: string }\n\n const data = await exchangeToken({ ...options, agent, userId })\n return Response.json(data)\n } catch (err) {\n const message = err instanceof Error ? err.message : \"Internal error\"\n return Response.json({ error: message }, { status: 500 })\n }\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAiBA,eAAsB,cAAc,SAA+B;AACjE,QAAM;AAAA,IACJ;AAAA,IACA,WAAW;AAAA,IACX,YAAY;AAAA,IACZ;AAAA,IACA;AAAA,EACF,IAAI;AAEJ,QAAM,MAAM,MAAM,MAAM,GAAG,QAAQ,cAAc;AAAA,IAC/C,QAAQ;AAAA,IACR,SAAS;AAAA,MACP,gBAAgB;AAAA,MAChB,eAAe,UAAU,MAAM;AAAA,IACjC;AAAA,IACA,MAAM,KAAK,UAAU;AAAA,MACnB;AAAA,MACA,QAAQ,QAAQ,CAAC,KAAK,IAAI;AAAA,MAC1B;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,MAAI,CAAC,IAAI,IAAI;AACX,UAAM,MAAM,MAAM,IAAI,KAAK,EAAE,MAAM,OAAO,EAAE,OAAO,2BAA2B,EAAE;AAChF,UAAM,IAAI,MAAM,IAAI,SAAS,0BAA0B,IAAI,MAAM,EAAE;AAAA,EACrE;AAEA,SAAO,IAAI,KAAK;AAClB;AAGO,SAAS,qBAAqB,SAA8B;AACjE,SAAO,eAAe,KAAK,KAAc;AACvC,QAAI;AACF,YAAM,OAAO,MAAM,IAAI,KAAK,EAAE,MAAM,OAAO,CAAC,EAAE;AAC9C,YAAM,EAAE,OAAO,OAAO,IAAI;AAE1B,YAAM,OAAO,MAAM,cAAc,EAAE,GAAG,SAAS,OAAO,OAAO,CAAC;AAC9D,aAAO,SAAS,KAAK,IAAI;AAAA,IAC3B,SAAS,KAAK;AACZ,YAAM,UAAU,eAAe,QAAQ,IAAI,UAAU;AACrD,aAAO,SAAS,KAAK,EAAE,OAAO,QAAQ,GAAG,EAAE,QAAQ,IAAI,CAAC;AAAA,IAC1D;AAAA,EACF;AACF;","names":[]}
@@ -0,0 +1,23 @@
1
+ interface TokenHandlerOptions {
2
+ /** Your an_sk_ API key — keep in process.env, never expose to client */
3
+ apiKey: string;
4
+ /** Relay URL. Default: "https://relay.an.dev" */
5
+ relayUrl?: string;
6
+ /** Token expiry. Default: "1h" */
7
+ expiresIn?: string;
8
+ }
9
+ interface ExchangeTokenOptions extends TokenHandlerOptions {
10
+ /** Agent slug to scope the token to */
11
+ agent?: string;
12
+ /** User identifier for the token */
13
+ userId?: string;
14
+ }
15
+ /** Exchange an an_sk_ API key for a short-lived JWT via the relay */
16
+ declare function exchangeToken(options: ExchangeTokenOptions): Promise<{
17
+ token: string;
18
+ expiresAt: string;
19
+ }>;
20
+ /** Create a Next.js API route handler that exchanges an_sk_ keys for JWTs */
21
+ declare function createAnTokenHandler(options: TokenHandlerOptions): (req: Request) => Promise<Response>;
22
+
23
+ export { type ExchangeTokenOptions, type TokenHandlerOptions, createAnTokenHandler, exchangeToken };
@@ -0,0 +1,23 @@
1
+ interface TokenHandlerOptions {
2
+ /** Your an_sk_ API key — keep in process.env, never expose to client */
3
+ apiKey: string;
4
+ /** Relay URL. Default: "https://relay.an.dev" */
5
+ relayUrl?: string;
6
+ /** Token expiry. Default: "1h" */
7
+ expiresIn?: string;
8
+ }
9
+ interface ExchangeTokenOptions extends TokenHandlerOptions {
10
+ /** Agent slug to scope the token to */
11
+ agent?: string;
12
+ /** User identifier for the token */
13
+ userId?: string;
14
+ }
15
+ /** Exchange an an_sk_ API key for a short-lived JWT via the relay */
16
+ declare function exchangeToken(options: ExchangeTokenOptions): Promise<{
17
+ token: string;
18
+ expiresAt: string;
19
+ }>;
20
+ /** Create a Next.js API route handler that exchanges an_sk_ keys for JWTs */
21
+ declare function createAnTokenHandler(options: TokenHandlerOptions): (req: Request) => Promise<Response>;
22
+
23
+ export { type ExchangeTokenOptions, type TokenHandlerOptions, createAnTokenHandler, exchangeToken };
package/dist/server.js ADDED
@@ -0,0 +1,45 @@
1
+ // src/server.ts
2
+ async function exchangeToken(options) {
3
+ const {
4
+ apiKey,
5
+ relayUrl = "https://relay.an.dev",
6
+ expiresIn = "1h",
7
+ agent,
8
+ userId
9
+ } = options;
10
+ const res = await fetch(`${relayUrl}/v1/tokens`, {
11
+ method: "POST",
12
+ headers: {
13
+ "Content-Type": "application/json",
14
+ Authorization: `Bearer ${apiKey}`
15
+ },
16
+ body: JSON.stringify({
17
+ userId,
18
+ agents: agent ? [agent] : void 0,
19
+ expiresIn
20
+ })
21
+ });
22
+ if (!res.ok) {
23
+ const err = await res.json().catch(() => ({ error: "Failed to exchange token" }));
24
+ throw new Error(err.error || `Token exchange failed: ${res.status}`);
25
+ }
26
+ return res.json();
27
+ }
28
+ function createAnTokenHandler(options) {
29
+ return async function POST(req) {
30
+ try {
31
+ const body = await req.json().catch(() => ({}));
32
+ const { agent, userId } = body;
33
+ const data = await exchangeToken({ ...options, agent, userId });
34
+ return Response.json(data);
35
+ } catch (err) {
36
+ const message = err instanceof Error ? err.message : "Internal error";
37
+ return Response.json({ error: message }, { status: 500 });
38
+ }
39
+ };
40
+ }
41
+ export {
42
+ createAnTokenHandler,
43
+ exchangeToken
44
+ };
45
+ //# sourceMappingURL=server.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/server.ts"],"sourcesContent":["export interface TokenHandlerOptions {\n /** Your an_sk_ API key — keep in process.env, never expose to client */\n apiKey: string\n /** Relay URL. Default: \"https://relay.an.dev\" */\n relayUrl?: string\n /** Token expiry. Default: \"1h\" */\n expiresIn?: string\n}\n\nexport interface ExchangeTokenOptions extends TokenHandlerOptions {\n /** Agent slug to scope the token to */\n agent?: string\n /** User identifier for the token */\n userId?: string\n}\n\n/** Exchange an an_sk_ API key for a short-lived JWT via the relay */\nexport async function exchangeToken(options: ExchangeTokenOptions) {\n const {\n apiKey,\n relayUrl = \"https://relay.an.dev\",\n expiresIn = \"1h\",\n agent,\n userId,\n } = options\n\n const res = await fetch(`${relayUrl}/v1/tokens`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n Authorization: `Bearer ${apiKey}`,\n },\n body: JSON.stringify({\n userId,\n agents: agent ? [agent] : undefined,\n expiresIn,\n }),\n })\n\n if (!res.ok) {\n const err = await res.json().catch(() => ({ error: \"Failed to exchange token\" }))\n throw new Error(err.error || `Token exchange failed: ${res.status}`)\n }\n\n return res.json() as Promise<{ token: string; expiresAt: string }>\n}\n\n/** Create a Next.js API route handler that exchanges an_sk_ keys for JWTs */\nexport function createAnTokenHandler(options: TokenHandlerOptions) {\n return async function POST(req: Request) {\n try {\n const body = await req.json().catch(() => ({}))\n const { agent, userId } = body as { agent?: string; userId?: string }\n\n const data = await exchangeToken({ ...options, agent, userId })\n return Response.json(data)\n } catch (err) {\n const message = err instanceof Error ? err.message : \"Internal error\"\n return Response.json({ error: message }, { status: 500 })\n }\n }\n}\n"],"mappings":";AAiBA,eAAsB,cAAc,SAA+B;AACjE,QAAM;AAAA,IACJ;AAAA,IACA,WAAW;AAAA,IACX,YAAY;AAAA,IACZ;AAAA,IACA;AAAA,EACF,IAAI;AAEJ,QAAM,MAAM,MAAM,MAAM,GAAG,QAAQ,cAAc;AAAA,IAC/C,QAAQ;AAAA,IACR,SAAS;AAAA,MACP,gBAAgB;AAAA,MAChB,eAAe,UAAU,MAAM;AAAA,IACjC;AAAA,IACA,MAAM,KAAK,UAAU;AAAA,MACnB;AAAA,MACA,QAAQ,QAAQ,CAAC,KAAK,IAAI;AAAA,MAC1B;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,MAAI,CAAC,IAAI,IAAI;AACX,UAAM,MAAM,MAAM,IAAI,KAAK,EAAE,MAAM,OAAO,EAAE,OAAO,2BAA2B,EAAE;AAChF,UAAM,IAAI,MAAM,IAAI,SAAS,0BAA0B,IAAI,MAAM,EAAE;AAAA,EACrE;AAEA,SAAO,IAAI,KAAK;AAClB;AAGO,SAAS,qBAAqB,SAA8B;AACjE,SAAO,eAAe,KAAK,KAAc;AACvC,QAAI;AACF,YAAM,OAAO,MAAM,IAAI,KAAK,EAAE,MAAM,OAAO,CAAC,EAAE;AAC9C,YAAM,EAAE,OAAO,OAAO,IAAI;AAE1B,YAAM,OAAO,MAAM,cAAc,EAAE,GAAG,SAAS,OAAO,OAAO,CAAC;AAC9D,aAAO,SAAS,KAAK,IAAI;AAAA,IAC3B,SAAS,KAAK;AACZ,YAAM,UAAU,eAAe,QAAQ,IAAI,UAAU;AACrD,aAAO,SAAS,KAAK,EAAE,OAAO,QAAQ,GAAG,EAAE,QAAQ,IAAI,CAAC;AAAA,IAC1D;AAAA,EACF;AACF;","names":[]}
@@ -0,0 +1,61 @@
1
+ # AN Platform Overview
2
+
3
+ AN is a platform for building, deploying, and embedding AI agents. You define an agent in TypeScript, deploy it with one command, and embed a chat UI in any React app.
4
+
5
+ ## Architecture
6
+
7
+ ```
8
+ Your Code (agent.ts)
9
+ |
10
+ v
11
+ @an-sdk/cli deploy (CLI)
12
+ |
13
+ v
14
+ AN Platform
15
+ |
16
+ +---> E2B Sandbox (isolated Node.js environment)
17
+ | |
18
+ | +---> Claude Agent SDK / Codex (executes your agent)
19
+ | |
20
+ | +---> Your custom tools run here
21
+ |
22
+ +---> AN Relay (relay.an.dev)
23
+ |
24
+ +---> SSE streaming to clients
25
+ |
26
+ +---> Token exchange (API key -> short-lived JWT)
27
+ ```
28
+
29
+ ## Packages
30
+
31
+ | Package | Purpose |
32
+ |---------|---------|
33
+ | `@an-sdk/agent` | Define agents and tools with type inference |
34
+ | `@an-sdk/cli` | Deploy agents from your terminal |
35
+ | `@an-sdk/react` | Chat UI components (theming, tool renderers) |
36
+ | `@an-sdk/nextjs` | Next.js server-side token handler |
37
+ | `@an-sdk/node` | Server-side SDK (sandboxes, threads, tokens) |
38
+
39
+ ## Key Concepts
40
+
41
+ - **Agent**: A TypeScript config defining model, system prompt, tools, and hooks. Runs in a cloud sandbox.
42
+ - **Tool**: A function your agent can call, with a Zod schema for input validation and full type inference.
43
+ - **Sandbox**: An isolated E2B cloud environment where your agent executes. Has Node.js, git, and system tools.
44
+ - **Thread**: A conversation within a sandbox. One sandbox can have multiple threads.
45
+ - **Relay**: The streaming gateway at `relay.an.dev`. Handles auth, routing, and SSE streaming.
46
+
47
+ ## Runtimes
48
+
49
+ AN supports two runtimes:
50
+
51
+ - **`claude-code`** (default) — Uses the Claude Agent SDK. Full tool use, file editing, bash execution.
52
+ - **`codex`** — Uses OpenAI Codex via ACP provider.
53
+
54
+ ## Auth Model
55
+
56
+ Two layers of authentication:
57
+
58
+ 1. **Client -> Relay**: API key (`an_sk_...`) or short-lived JWT (via token exchange)
59
+ 2. **Sandbox -> AI Provider**: Handled internally by the platform (Claude Proxy)
60
+
61
+ For web apps, use `@an-sdk/nextjs` to exchange your API key for a short-lived JWT on the server, so the key never reaches the browser.
@@ -0,0 +1,110 @@
1
+ # Getting Started
2
+
3
+ ## 1. Get an API Key
4
+
5
+ Sign up at [an.dev](https://an.dev) and get your API key from [an.dev/agents/dashboard/api](https://an.dev/agents/dashboard/api).
6
+
7
+ ## 2. Install
8
+
9
+ ```bash
10
+ npm install @an-sdk/agent zod
11
+ ```
12
+
13
+ ## 3. Define Your Agent
14
+
15
+ Create `src/agent.ts`:
16
+
17
+ ```ts
18
+ import { agent, tool } from "@an-sdk/agent"
19
+ import { z } from "zod"
20
+
21
+ export default agent({
22
+ model: "claude-sonnet-4-6",
23
+ systemPrompt: "You are a helpful coding assistant.",
24
+ tools: {
25
+ greet: tool({
26
+ description: "Greet a user by name",
27
+ inputSchema: z.object({ name: z.string() }),
28
+ execute: async ({ name }) => ({
29
+ content: [{ type: "text", text: `Hello, ${name}!` }],
30
+ }),
31
+ }),
32
+ },
33
+ })
34
+ ```
35
+
36
+ ## 4. Login & Deploy
37
+
38
+ ```bash
39
+ npx @an-sdk/cli login
40
+ # Enter your API key: an_sk_...
41
+
42
+ npx @an-sdk/cli deploy
43
+ # Bundling src/agent.ts...
44
+ # Deploying my-agent...
45
+ # https://api.an.dev/v1/chat/my-agent
46
+ ```
47
+
48
+ Your agent is live.
49
+
50
+ ## 5. Embed in a React App
51
+
52
+ ```bash
53
+ npm install @an-sdk/nextjs @an-sdk/react ai @ai-sdk/react
54
+ ```
55
+
56
+ Create a token route (keeps your API key on the server):
57
+
58
+ ```ts
59
+ // app/api/an/token/route.ts
60
+ import { createAnTokenHandler } from "@an-sdk/nextjs/server"
61
+
62
+ export const POST = createAnTokenHandler({
63
+ apiKey: process.env.AN_API_KEY!,
64
+ })
65
+ ```
66
+
67
+ Add the chat UI:
68
+
69
+ ```tsx
70
+ // app/page.tsx
71
+ "use client"
72
+
73
+ import { useChat } from "@ai-sdk/react"
74
+ import { AnAgentChat, createAnChat } from "@an-sdk/nextjs"
75
+ import "@an-sdk/react/styles.css"
76
+ import { useMemo } from "react"
77
+
78
+ export default function Chat() {
79
+ const chat = useMemo(
80
+ () => createAnChat({
81
+ agent: "your-agent-slug",
82
+ tokenUrl: "/api/an/token",
83
+ }),
84
+ [],
85
+ )
86
+
87
+ const { messages, sendMessage, status, stop, error } = useChat({ chat })
88
+
89
+ return (
90
+ <AnAgentChat
91
+ messages={messages}
92
+ onSend={(msg) =>
93
+ sendMessage({ parts: [{ type: "text", text: msg.content }] })
94
+ }
95
+ status={status}
96
+ onStop={stop}
97
+ error={error}
98
+ />
99
+ )
100
+ }
101
+ ```
102
+
103
+ ## Next Steps
104
+
105
+ - [Defining Agents](./03-defining-agents.md) — Models, tools, hooks, permissions
106
+ - [React UI](./04-react-ui.md) — Theming, slots, tool renderers
107
+ - [Next.js Integration](./05-nextjs.md) — Server-side token handler
108
+ - [Node SDK](./06-node-sdk.md) — Sandboxes, threads, tokens from server code
109
+ - [CLI Reference](./07-cli.md) — All CLI commands
110
+ - [Custom Tools](./08-custom-tools.md) — Build custom tool renderers
@@ -0,0 +1,159 @@
1
+ # Defining Agents
2
+
3
+ Agents are defined with the `agent()` and `tool()` functions from `@an-sdk/agent`. These are config-only — they return exactly what you pass in, with type inference added. The actual execution happens in the AN runtime (E2B sandbox).
4
+
5
+ ## `agent(config)`
6
+
7
+ ```ts
8
+ import { agent } from "@an-sdk/agent"
9
+
10
+ export default agent({
11
+ // Model (default: "claude-sonnet-4-6")
12
+ model: "claude-sonnet-4-6",
13
+
14
+ // System prompt
15
+ systemPrompt: "You are a PR reviewer...",
16
+
17
+ // Custom tools (see below)
18
+ tools: { /* ... */ },
19
+
20
+ // Runtime: "claude-code" (default) or "codex"
21
+ runtime: "claude-code",
22
+
23
+ // Permission mode: "default", "acceptEdits", or "bypassPermissions"
24
+ permissionMode: "default",
25
+
26
+ // Max conversation turns (default: 50)
27
+ maxTurns: 50,
28
+
29
+ // Max budget in USD
30
+ maxBudgetUsd: 5,
31
+
32
+ // Lifecycle hooks (see below)
33
+ onStart: async () => {},
34
+ onToolCall: async ({ toolName, input }) => {},
35
+ onToolResult: async ({ toolName, input, output }) => {},
36
+ onStepFinish: async ({ step }) => {},
37
+ onFinish: async ({ result }) => {},
38
+ onError: async ({ error }) => {},
39
+ })
40
+ ```
41
+
42
+ ### Defaults
43
+
44
+ | Field | Default |
45
+ |-------|---------|
46
+ | `model` | `"claude-sonnet-4-6"` |
47
+ | `runtime` | `"claude-code"` |
48
+ | `permissionMode` | `"default"` |
49
+ | `maxTurns` | `50` |
50
+ | `tools` | `{}` |
51
+
52
+ ## `tool(definition)`
53
+
54
+ ```ts
55
+ import { tool } from "@an-sdk/agent"
56
+ import { z } from "zod"
57
+
58
+ const myTool = tool({
59
+ description: "What this tool does",
60
+ inputSchema: z.object({
61
+ path: z.string(),
62
+ verbose: z.boolean().optional(),
63
+ }),
64
+ execute: async (args) => {
65
+ // args is fully typed: { path: string; verbose?: boolean }
66
+ return {
67
+ content: [{ type: "text", text: "result" }],
68
+ }
69
+ },
70
+ })
71
+ ```
72
+
73
+ The `execute` function receives args typed from the Zod schema. Return value must have `content` array with `{ type: "text", text: string }` items.
74
+
75
+ ## Hooks
76
+
77
+ ### `onToolCall`
78
+
79
+ Runs before a tool executes. Return `false` to block it.
80
+
81
+ ```ts
82
+ onToolCall: async ({ toolName, input }) => {
83
+ if (toolName === "Bash" && input.command?.includes("rm -rf")) {
84
+ return false // blocked
85
+ }
86
+ }
87
+ ```
88
+
89
+ ### `onToolResult`
90
+
91
+ Runs after a tool executes with the result.
92
+
93
+ ```ts
94
+ onToolResult: async ({ toolName, input, output }) => {
95
+ console.log(`Tool ${toolName} returned:`, output)
96
+ }
97
+ ```
98
+
99
+ ### `onFinish`
100
+
101
+ Runs when the agent completes successfully.
102
+
103
+ ```ts
104
+ onFinish: async ({ result }) => {
105
+ await fetch("https://my-api.com/webhook", {
106
+ method: "POST",
107
+ body: JSON.stringify({ done: true }),
108
+ })
109
+ }
110
+ ```
111
+
112
+ ### `onError`
113
+
114
+ Runs when the agent encounters an error.
115
+
116
+ ```ts
117
+ onError: async ({ error }) => {
118
+ console.error("Agent failed:", error)
119
+ }
120
+ ```
121
+
122
+ ## Permission Modes
123
+
124
+ | Mode | Behavior |
125
+ |------|----------|
126
+ | `"default"` | Agent asks for confirmation on risky operations |
127
+ | `"acceptEdits"` | Auto-approve file edits, still confirm other actions |
128
+ | `"bypassPermissions"` | Auto-approve everything (use with caution) |
129
+
130
+ ## Type Reference
131
+
132
+ ```ts
133
+ // Agent config (all fields required — defaults filled by agent())
134
+ interface AgentConfig {
135
+ model: string
136
+ systemPrompt: string
137
+ tools: ToolSet
138
+ runtime: "claude-code" | "codex"
139
+ permissionMode: "default" | "acceptEdits" | "bypassPermissions"
140
+ maxTurns: number
141
+ maxBudgetUsd?: number
142
+ onStart?: () => Promise<void>
143
+ onToolCall?: (payload: { toolName: string; input: any }) => Promise<boolean | void>
144
+ onToolResult?: (payload: { toolName: string; input: any; output: any }) => Promise<void>
145
+ onStepFinish?: (payload: { step: any }) => Promise<void>
146
+ onFinish?: (payload: { result: any }) => Promise<void>
147
+ onError?: (payload: { error: Error }) => Promise<void>
148
+ }
149
+
150
+ // Tool definition — generic over Zod schema
151
+ interface ToolDefinition<TInput> {
152
+ description: string
153
+ inputSchema: ZodType<TInput>
154
+ execute: (args: TInput) => Promise<{ content: { type: string; text: string }[] }>
155
+ }
156
+
157
+ // Tool set
158
+ type ToolSet = Record<string, ToolDefinition<any>>
159
+ ```