Public API overview
Anki Forge is an open-source Anki APKG generation library with a Rust core and
Rust, Python and Node.js interfaces. Use the public ankiforge package to author
notes, package media and inspect updates before distributing a new deck. MIT licensed.
| Task | Rust | Python | Node / TypeScript |
|---|---|---|---|
| Author notes and models | Rust API | Python API | Node API |
| Images, audio and occlusion | Media | Owned media | Owned media |
| Diagnose failures | Troubleshooting | Diagnostics | Errors |
| Compare and publish | Update workflow | Build and compare | Build and compare |
Stable note identity
Section titled “Stable note identity”Keep a stable project namespace and note key for each logical note. Updating an existing release also requires its original distribution APKG. An Anki re-export is not a substitute for the complete identity evidence in that original package.
Start with a task
Section titled “Start with a task”Choose your language or follow the complete JSON generation and update recipe. See compatibility for published runtimes and output guarantees for file ownership.