Rust API

Switchyard publishes generated API documentation for its embeddable routing library, provider-neutral protocol types, and format translation.

switchyard-libsy

Use libsy to construct targets, run built-in routing algorithms, implement a custom algorithm, or drive model calls through the host-facing step stream.

Open the generated libsy API documentation

switchyard-protocol

Use protocol types for normalized conversations, response streams, routed LLM clients, decisions, metadata, and wire-format identifiers.

Open the generated protocol API documentation

switchyard-translation

Use translation to convert requests, responses, and streams between OpenAI Chat Completions, OpenAI Responses, and Anthropic Messages formats.

Open the generated translation API documentation

Crate boundary

Applications embedding libsy normally depend on the libsy and protocol crates:

[dependencies]
switchyard-libsy = { git = "https://github.com/NVIDIA-NeMo/Switchyard.git", tag = "v0.3.0" }
switchyard-protocol = { git = "https://github.com/NVIDIA-NeMo/Switchyard.git", tag = "v0.3.0" }

Import algorithms and orchestration types from switchyard_libsy. Import requests, responses, metadata, decisions, and LLM client traits from switchyard_protocol. Keep both dependencies on compatible versions.

Add switchyard-translation when your application directly converts requests, responses, or streams between provider formats. Use a version compatible with your other Switchyard dependencies.

CI previews

The Documentation workflow publishes a preview for same-repository pull requests. Open the workflow's Deploy PR preview summary to find its preview URL, then use the Rust API links above. The docs-site build artifact contains the same MkDocs and rustdoc output for one day.