Generated SDK Reference

Generated from @synapsex/sdk TypeScript sources.

Package: @synapsex/sdk
Version: 0.1.0
Classes: 14
Exported types/interfaces: 36

Install

npm install @synapsex/sdk

Classes

`AgentClient`

Source: agents.ts

Method	Parameters
`list`	`filters?: AgentListFilters`
`get`	`id: string`
`create`	`data: AgentCreateRequest`
`stop`	`id: string`
`restart`	`id: string`
`dispatch`	`id: string, input: string`
`getLogs`	`id: string, lines = 100`

`AuthClient`

Source: auth.ts

Method	Parameters
`login`	`email: string, password: string, tenantSlug: string`
`logout`	“
`refresh`	“
`me`	“

`BillingClient`

Source: billing.ts

Method	Parameters
`getBalance`	“
`addCredits`	`amount: number, description: string, referenceId?: string, referenceType?: string`
`deductCredits`	`amount: number, description: string, referenceId?: string, referenceType?: string`
`getTransactions`	`options?: { limit?: number; offset?: number; type?: string; startDate?: string; endDate?: string; }`
`checkQuota`	`agentId?: string`
`recordUsage`	`params: { provider: string; model: string; inputTokens: number; outputTokens: number; baseCost: number; agentId?: string; apiKeyId?: string; requestId?: string; correlationId?: string; metadata?: Record<string, unknown>; }`
`getUsageSummary`	`startDate?: string, endDate?: string`
`getAgentUsage`	`agentId: string, startDate?: string, endDate?: string`
`getSubscription`	“
`createSubscription`	`planId: string`
`getPortalSession`	“
`cancelSubscription`	`immediately: boolean = false`
`changePlan`	`planId: string`
`getInvoices`	`limit: number = 10`
`getUpcomingInvoice`	“
`getPlans`	“
`getReferralCode`	“
`redeemReferralCode`	`code: string`

`SynapseXClient`

Source: client.ts

Method	Parameters
`setAccessToken`	`token: string`
`getAccessToken`	“
`dispose`	“

`EventStreamClient`

Source: events.ts

Method	Parameters
`unsubscribe`	`subscription: EventSubscription`
`close`	“

`ApiError`

Source: http.ts

Method	Parameters

`HttpClient`

Source: http.ts

Method	Parameters
`setAccessToken`	`token: string`
`getAccessToken`	“
`sseUrl`	`path: string`

`IncidentClient`

Source: incidents.ts

Method	Parameters
`list`	`filters?: IncidentListFilters`
`get`	`id: string`
`create`	`data: IncidentCreateRequest`
`update`	`id: string, data: IncidentUpdateRequest`
`resolve`	`id: string`
`triggerAnalysis`	`id: string`

`MCPRouterClient`

Source: mcp-router.ts

Method	Parameters
`listServers`	`domain?: string`
`listTools`	`domain?: string`
`route`	`request: MCPRouterRequest`
`plan`	`request: MCPRouterRequest`
`ask`	`request: MCPRouterAskRequest`
`execute`	`request: MCPRouterAskRequest`

`RoutingError`

Source: routing.ts

Method	Parameters

`LLMRoutingEngine`

Source: routing.ts

Method	Parameters
`select`	`ctx: RoutingContext`
`buildFallbackChain`	`env: string`

`SecretClient`

Source: secrets.ts

Method	Parameters
`list`	`filters?: SecretListFilters`
`get`	`id: string`
`create`	`data: SecretCreateRequest`
`rotate`	`id: string`
`delete`	`id: string`

`TaskClient`

Source: tasks.ts

Method	Parameters
`create`	`req: TaskCreateRequest`
`get`	`id: string`
`list`	`filters?: TaskListFilters`
`stream`	`id: string, onEvent: TaskStreamHandler`

`VMClient`

Source: vms.ts

Method	Parameters
`list`	`filters?: VMListFilters`
`get`	`id: string`
`getMetrics`	`id: string`
`getAgents`	`id: string`

Exported types

Type	Source
`AgentCreateRequest`	`agents.ts`
`AgentListFilters`	`agents.ts`
`BillingBalance`	`billing.ts`
`CreditTransaction`	`billing.ts`
`CreditTransactionTypeEnum`	`types.ts`
`EventStreamClientOptions`	`events.ts`
`EventSubscription`	`events.ts`
`HttpClientOptions`	`http.ts`
`IncidentCreateRequest`	`incidents.ts`
`IncidentListFilters`	`incidents.ts`
`IncidentUpdateRequest`	`incidents.ts`
`Invoice`	`billing.ts`
`InvoiceStatusEnum`	`types.ts`
`LlmProviderEnum`	`types.ts`
`MCPPlanStep`	`mcp-router.ts`
`MCPRouterAskRequest`	`mcp-router.ts`
`MCPRouterPlan`	`mcp-router.ts`
`MCPRouterRequest`	`mcp-router.ts`
`MCPRouterResult`	`mcp-router.ts`
`MCPServerInfo`	`mcp-router.ts`
`PlanInfo`	`billing.ts`
`PlanType`	`types.ts`
`QuotaCheckResult`	`billing.ts`
`RoutingContext`	`routing.ts`
`RoutingPolicy`	`routing.ts`
`SecretCreateRequest`	`secrets.ts`
`SecretListFilters`	`secrets.ts`
`Subscription`	`billing.ts`
`SubscriptionStatusType`	`types.ts`
`SynapseXClientOptions`	`client.ts`
`TaskListFilters`	`tasks.ts`
`TaskStreamHandler`	`tasks.ts`
`TokenRefreshedCallback`	`http.ts`
`UsageSummary`	`billing.ts`
`VMListFilters`	`vms.ts`
`WSMessageHandler`	`events.ts`

​Generated SDK Reference

​Install

​Classes

​AgentClient

​AuthClient

​BillingClient

​SynapseXClient

​EventStreamClient

​ApiError

​HttpClient

​IncidentClient

​MCPRouterClient

​RoutingError

​LLMRoutingEngine

​SecretClient

​TaskClient

​VMClient

​Exported types