API reference
API reference¶
These pages are generated from the public Rust API surface. You can run task alef:generate (or alef docs) after changing types, options, or alef.toml so the Markdown under docs/reference/ stays in sync.
| Topic | Link |
|---|---|
| All types and result shapes | Types |
| Options, metadata, and field tables | Configuration (generated) |
| Error / enum reference | Error types (generated) |
Language APIs¶
| Language | Page |
|---|---|
| Rust | api-rust |
| Python | api-python |
| TypeScript / Node | api-typescript |
| Go | api-go |
| Ruby | api-ruby |
| PHP | api-php |
| Java | api-java |
| C# | api-csharp |
| Elixir | api-elixir |
| R | api-r |
| Kotlin (Android) | api-kotlin-android |
| Swift | api-swift |
| Dart | api-dart |
| Zig | api-zig |
| C (FFI) | api-c |
| WebAssembly | api-wasm |
For how to use the API in your language, start with Language guides and the narrative Configuration and Error handling pages; this section is the exhaustive field-level reference.