Skip to main content

Documentation Index

Fetch the complete documentation index at: https://zpg6.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

You’ll need a swarmlord account. Sign up at swarmlord.ai.

1. Install the CLI

npm install -g swarmlord
# or: bun add -g swarmlord

2. Log in

swarmlord login
Opens the dashboard, mints an API key, writes it to ~/.config/swarmlord/credentials.

3. Create an agent

swarmlord init hello-agent
cd hello-agent
The scaffolded swarmlord.jsonc:
{
  "name": "hello-agent",
  "model": { "providerId": "openrouter", "modelId": "anthropic/claude-opus-4.8" },
  "instructions": "You are a helpful agent."
}

4. Deploy

swarmlord deploy
✔ Deployed agent 68406838-321f-40b5-88d0-b8ab93c54c1b

5. Run it

swarmlord run -m "In one sentence, introduce yourself."
→ assistant
Hi! I'm hello-agent, here to help with whatever you need.

6. Call from TypeScript

npm install swarmlord
import { createClient } from "swarmlord";

const client = createClient({ apiKey: process.env.SWARMLORD_API_KEY! });

const session = await client.agent("hello-agent").createSession();
const { value } = await session
  .send({ parts: [{ type: "text", text: "Say hi." }] })
  .result<string>();

console.log(value);

You're done

A live agent reachable from curl, the SDK, the CLI, and the dashboard.

Next

Agents

Every field in swarmlord.jsonc.

Sessions

Streaming, multi-turn, fork, abort, resume.

MCPs

Connect Sendblue, GitHub, Slack, and more.

Daily research agent

Build an agent that texts you the news.