The @supaproxy/sdk package is a TypeScript client for the SupaProxy API. It wraps every API endpoint with typed methods and handles authentication via cookies.
Features
- Typed methods for every API endpoint
- Cookie-based authentication (
credentials: 'include' by default)
- Custom error class (
SupaProxyError) with HTTP status codes
- Full TypeScript types for all request and response shapes
- Works in browsers, Node.js, and server-side frameworks
Quick example
import { SupaProxyClient } from '@supaproxy/sdk';
const client = new SupaProxyClient('http://localhost:3001');
// Login
await client.auth.login({ email: 'jane@acme.com', password: 'securepass' });
// List workspaces
const { workspaces } = await client.workspaces.list();
// Query a workspace
const result = await client.workspaces.query('ws-support-bot', {
query: 'What is the status of order ORD-2026-001?'
});
console.log(result.answer);
API groups
The client organises methods into groups:
| Group | Access | Description |
|---|
client.auth | AuthAPI | Login, signup, session, logout |
client.org | OrgAPI | Organisation CRUD, settings, users, models |
client.workspaces | WorkspacesAPI | Workspace CRUD, dashboard, query, resources |
client.connections | ConnectionsAPI | Connection deletion |
client.connectors | ConnectorsAPI | MCP testing/saving, consumer connection |
client.conversations | ConversationsAPI | Conversation list, detail, close |
client.queues | QueuesAPI | Background job queue management |
Status
The SDK is at v0.1.x (alpha). The API surface may change between minor versions.
