Skip to content

API Reference

Use these sections to explore Alloy’s public API. Each page is generated from source code via mkdocstrings and stays up‑to‑date.

  • Top-level: api/alloy.md — package exports (ask, @command, @tool, configure, errors)
  • Ask: api/ask.md — ask(...), streaming helpers
  • Command: api/command.md — @command decorator and helpers
  • Config: api/config.md — configure(...), Config
  • Tools: api/tool.md — @tool, contracts (@require/@ensure)
  • Errors: api/errors.md — CommandError, ConfigurationError, etc.
  • Types: api/types.md — typing helpers and structured outputs
  • Models: api/models/* — provider backends

See also: Guide pages for concepts and practical usage.