Quickstart

Get your first agent reporting to AgentOS in under 5 minutes.

1. Add your AI provider key

AgentOS needs your Anthropic or OpenAI key to run agents. Add it in Settings → Keys → AI Provider Keys.

2. Create an agent

Go to Agents → New agent. Give it a name and description. Once created, open the agent and generate an agent key — you'll need the agent ID and agent key in the next step.

3. Install the SDK

npm install @agentos-sdk/core

4. Wrap your agent code

import { AgentOS } from "@agentos-sdk/core";

const client = new AgentOS({
  agentId: "your-agent-id",
  apiKey: "aos_agent_...",
});

const run = await client.startRun({ input: { query: "Hello" } });

// emit events as your agent works
run.emit("step.started", { step: "fetch-data" });

// complete or fail the run
await run.complete({ output: { result: "Done" } });

AgentOS will start showing runs, events, and reports in your dashboard automatically.

---

Next steps

• TypeScript SDK reference — all methods and options
• API reference — raw HTTP endpoints