Skip to content

API reference

For short examples of every resource method in F#, JavaScript, TypeScript, and Python, see Resource API.

The API surface is identical across all three targets — one F# source tree produces every package — so the generated F# API reference is the authoritative reference for .NET, JavaScript/TypeScript, and Python alike. Member names and defaults carry over to each language. Python parameter names use snake_case (for example, refName becomes ref_name), and the async wrapper differs per language (Async / Promise / awaitable).

Open the F# API reference — generated by fsdocs from the XML documentation comments in the source tree.

Note

The reference is generated into site/fsdocs/ by ./build.sh BuildDocs; when previewing the guide with mkdocs serve alone, the link above 404s.