API Reference | NVIDIA Dynamo Documentation

This page is for version dev. For other versions, use one of these documentation indexes: - Latest (v1.6.1) (default): https://docs.nvidia.com/dynamo/latest/llms.txt - dev: https://docs.nvidia.com/dynamo/dev/llms.txt - v1.6.1: https://docs.nvidia.com/dynamo/v1.6.1/llms.txt - v1.6.0: https://docs.nvidia.com/dynamo/v1.6.0/llms.txt - v1.5.1: https://docs.nvidia.com/dynamo/v1.5.1/llms.txt - v1.5.0: https://docs.nvidia.com/dynamo/v1.5.0/llms.txt - v1.4.2: https://docs.nvidia.com/dynamo/v1.4.2/llms.txt - v1.4.1: https://docs.nvidia.com/dynamo/v1.4.1/llms.txt - v1.4.0: https://docs.nvidia.com/dynamo/v1.4.0/llms.txt - v1.3.0: https://docs.nvidia.com/dynamo/v1.3.0/llms.txt - v1.2.1: https://docs.nvidia.com/dynamo/v1.2.1/llms.txt - v1.2.0: https://docs.nvidia.com/dynamo/v1.2.0/llms.txt - v1.1.1: https://docs.nvidia.com/dynamo/v1.1.1/llms.txt - v1.1.0: https://docs.nvidia.com/dynamo/v1.1.0/llms.txt - v1.0.2: https://docs.nvidia.com/dynamo/v1.0.2/llms.txt - v1.0.1: https://docs.nvidia.com/dynamo/v1.0.1/llms.txt - v1.0.0: https://docs.nvidia.com/dynamo/v1.0.0/llms.txt - v0.9.1: https://docs.nvidia.com/dynamo/v-0-9-1/llms.txt - v0.9.0: https://docs.nvidia.com/dynamo/v-0-9-0/llms.txt - v0.8.1: https://docs.nvidia.com/dynamo/v-0-8-1/llms.txt - v0.8.0: https://docs.nvidia.com/dynamo/v-0-8-0/llms.txt - v0.7.1: https://docs.nvidia.com/dynamo/v-0-7-1/llms.txt - v0.7.0: https://docs.nvidia.com/dynamo/v-0-7-0/llms.txt

Python

Eleven modules: worker decorators, the HTTP frontend, planner, router and mocker configuration, and the Rust-backed runtime bindings.

Rust

Distributed runtime crates published on crates.io, pinned to the current release.

Kubernetes

Custom-resource fields for DynamoGraphDeployment, DynamoGraphDeploymentRequest and DynamoComponentDeployment.

The language and Kubernetes references are generated from Dynamo’s source tree. Each module page lists every class and function, expands into per-symbol signatures and public methods, and deep-links to the exact file and line on main.

For HTTP request contracts, see the frontend endpoints and the Image Edits API.

Coverage

Python — the Python API landing page indexes every curated module. Class methods and function signatures are pulled directly from the source; there are no hand-maintained tables.
Rust — see the published ai-dynamo crates on crates.io and the release artifact inventory for currently shipped crate versions.
Kubernetes — the Kubernetes API reference documents the full DynamoGraphDeployment / DynamoComponentDeployment custom-resource surface. Trimmed per-CRD references (DGD, DGDR, DCD) live as siblings under the same section so every deep link resolves.

These pages are generated and carry a do not edit marker. Python and Rust come from docstrings read by griffe: edit the source, then rerun gen_python_api.py or gen_rust_api.py in docs/fern/scripts/. Kubernetes takes one more hop — make generate-api-docs in deploy/operator/ turns the CRD Go types into api-reference-k8s.md, which gen_kubernetes_api.py then renders, so editing a Go type and rerunning the renderer alone changes nothing. The Python and Rust pages are not committed: the docs pipeline generates them at publish time, and the Generated API References pre-merge job reruns both generators to prove a source change cannot break them. Only the Kubernetes output stays committed, checked with --check scoped to the branch’s own changes on a pull request and strict on main.