Guides

Task-oriented guides for common StreamBlocks workflows. Each guide is backed by runnable examples from the repository.

Building blocks

• Defining Custom Blocks: typed metadata/content models, custom parsing, JSON/YAML content.
• Generating Prompts: build an LLM system prompt from your registry.
• Validation: registry validators, failure modes, early validation.
• Error Handling: error codes, unclosed blocks, size limits.

Connecting streams

• OpenAI, Anthropic & Gemini: provider streams with auto-detected adapters.
• AG-UI Protocol: bidirectional AG-UI integration.
• Pydantic AI: extract blocks from agent streams.

Operating

• Logging: stdlib, structlog, loguru, or custom loggers.
• Performance Tuning: configuration knobs and trade-offs.

Looking for conceptual background instead? See Concepts. Complete runnable programs live in Examples.