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.
A session is one live conversation with an agent. Each session has its own memory and its own event stream.
createSession ─▶ send ─▶ stream events ─▶ session.completed
│
├─▶ fork ─▶ (new session, shared history)
├─▶ abort ─▶ session.aborted
└─▶ events?sinceSeq=N ─▶ replay
Create one
const session = await client.agent("hello-agent").createSession();
Get a reply
const { value } = await session
.send({ parts: [{ type: "text", text: "Say hi." }] })
.result<string>();
result() resolves on the first terminal event.
Stream the events
for await (const ev of session.stream({ parts: [{ type: "text", text: "Hi" }] })) {
if (ev.type === "part.appended" && ev.part.type === "text") {
process.stdout.write(ev.part.text);
}
if (ev.type === "session.completed") break;
}
Multi-turn
A session keeps state between sends:
const session = await client.agent("multi-turn").createSession();
await session.send({ parts: [{ type: "text", text: "My name is Ada." }] }).result();
const { value } = await session.send({ parts: [{ type: "text", text: "What's my name?" }] }).result();
// → "Your name is Ada."
Fork
Snapshot a session and continue both branches independently:
const forkRes = await fetch(`https://api.swarmlord.ai/session/${root.id}/fork`, {
method: "POST",
headers: { Authorization: `Bearer ${apiKey}` },
});
const { id } = await forkRes.json();
const forked = client.session(id);
Resume
Reconnect to a session and replay missed events:
import { streamSession } from "swarmlord";
const stream = streamSession(session.id, {
opts: { apiKey },
sinceSeq: lastSeen,
});
Abort
Cancels the in-flight model call and emits session.aborted.
Terminal guarantee
Every session reaches a terminal event (session.completed, session.completed_degraded, or session.aborted). Consumers never hang.
See Events for the full vocabulary.
