Client SDK: Getting Started

The Switchboard.Client provides strongly-typed SDKs for C# (.NET) and TypeScript (Node.js/Browser). These clients encapsulate core HTTP interactions, handle multipart file streaming, coordinate multi-size generations, and implement high-efficiency polling.


Integration Path

To get integrated with the Switchboard orchestration engine:

  1. Setup & Configuration: Add the library dependency and initialize the client instance using dependency injection or static factories.
  2. Logical Workspaces: Connect your client to a specific logical workspace to enforce storage, database, and security isolation.
  3. Simple Generation: Execute single-line method calls that handle the entire lifecycle of uploading, polling, and downloading.
  4. Advanced Manual Usage: Break upload and download phases apart for distributed event systems, client-side polling, or long-running tasks.
  5. Other Capabilities: Learn about generating multi-size packages, variation batches, setting custom timeouts, and parsing capture lifecycles.