Class: Session

const session = await agent.createSession()
await session.send("Remember that the service uses PostgreSQL.")
await session.send("Suggest a backup strategy.")

new Session(ctx): Session;

readonly directory: string;

readonly id: string;

readonly optional workspaceId?: string;

get usage(): SessionUsage;

abort(): Promise<void>;

await session.abort()

checkpoint(label?): Promise<CheckpointHandle>;

const checkpoint = await session.checkpoint("before-change")

close(): Promise<void>;

await session.close()

command(
   name,
   args?,
   options?
): Promise<ResultMessage>;

await session.command("review", "src/client.ts")

compact(options?): Promise<CompactResult>;

getAppliedSettings(): Promise<AppliedSettings>;

console.log((await session.getAppliedSettings()).settingSources)

getTodos(): Promise<Todo[]>;

console.log(await session.getTodos())

interrupt(): Promise<void>;

await session.interrupt()

listCheckpoints(): Promise<CheckpointHandle[]>;

const checkpoints = await session.listCheckpoints()

messages(): Promise<AgentMessage[]>;

const history = await session.messages()

rename(title): Promise<void>;

await session.rename("Release review")

rewind(checkpointId): Promise<RewindResult>;

await session.rewind(checkpoint.id)

send(prompt): Promise<ResultMessage>;

const result = await session.send("Summarize the report.")

setAgents(agents): Promise<void>;

await session.setAgents({ reviewer: { prompt: "Review correctness." } })

setModel(model): Promise<void>;

await session.setModel("anthropic/claude-sonnet-4-5")

setPermissionMode(_mode): Promise<void>;

await session.setPermissionMode("dontAsk")

stream(prompt, options?): AsyncGenerator<AgentMessage, ResultMessage>;

for await (const message of session.stream("Hello")) console.log(message.type)

tag(tag): Promise<void>;

await session.tag("review")

todos(options?): AsyncGenerator<Todo[]>;

for await (const todos of session.todos({ signal })) console.log(todos)

untag(tag): Promise<void>;

await session.untag("review")