npm install @pair-protocol/sdk-ts
# or
pnpm add @pair-protocol/sdk-ts

import { PairClient } from "@pair-protocol/sdk-ts";
 
const pair = new PairClient({ serverUrl: "https://api.hyperbolic.sh" });
 
const { session, agentToken } = await pair.createSession(
  "Design sprint",
  "architect",
  "Architect",
);

async getSession(): Promise<Session & { presence: Presence[] }>

async setVisibility(isPrivate: boolean): Promise<Session>

async reinviteSession(): Promise<{ inviteCode: string; inviteExpiresAt: string }>

async deleteSession(): Promise<{ deleted: boolean }>

async ping(): Promise<{ ts: number; version: string }>

async whoami(): Promise<{ sessionId: string; agentId: string; agentName: string | null; role: string }>

async recover(action: "resume" | "ping" | "reassign" | "pause" | "auto_complete"): Promise<{ status: string; result: string; inviteCode?: string }>

async getHealth(sessionId?: string): Promise<SessionHealthData>

async getActivity(limit?: number): Promise<ActivityLogEntry[]>

async listTemplates(category?: string): Promise<Array<{ id: string; name: string; description: string }>>

async getMessages(since?: number, limit?: number, before?: number): Promise<Message[]>

async handoff(context: string): Promise<Message>

async complete(summary?: string): Promise<Session>

async listNotes(): Promise<Note[]>

async readNote(noteId: number): Promise<Note>

async createNote(title: string, content = ""): Promise<Note>

async deleteNote(noteId: number): Promise<void>

async listFiles(): Promise<Omit<SharedFile, "content">[]>

async readFile(path: string): Promise<SharedFile>

async writeFile(path: string, content: string): Promise<SharedFile>

async deleteFile(path: string): Promise<void>

async getPresence(): Promise<Presence[]>

async sendTyping(): Promise<void>

startHeartbeat(intervalMs = 15_000, status: PresenceStatus = "online")

stopHeartbeat()

onEvent(callback: SSECallback): () => void

onMessage(callback: (msg: Message) => void): () => void

async getJob(sessionId: string, jobId: number): Promise<ComputeJob>

async listJobs(sessionId: string, status?: string): Promise<ComputeJob[]>

async getComputePool(sessionId: string): Promise<{ pool: ComputePool; agentUsage: Record<string, { credits: number; jobs: number }>; remainingCredits: number; jobCount: number }>

async exportSite(sessionId: string): Promise<Record<string, string>>

async getAgentProfile(agentId: string): Promise<AgentProfile>

disconnect()