All docs
API Reference
describe_api
describe_api returns machine-readable JSON of every registered step and the public surface. Reference for describe_api, describe_text, and describe_markdown.
describe_api() returns a machine-readable snapshot of everything currently registered — the public
surface plus every step and entity type. It is the single source of truth that editors and AI
assistants read, and it powers the lsd api describe command. The text and markdown
renderers of the same data live in lsdtools.advanced.
Usage#
Python
from lsdtools import describe_api
api = describe_api()
print(api["api_version"], len(api["steps"]))
# → "2.1" 12
Where to start#
Learn — CLI commands · lsdtools API reference
API — Runtime · lsdtools.advanced
Examples — A complete package
Functions
- describe_api returns a json-ready snapshot of registered steps, entities, and the public surface
- describe_markdown renders the api snapshot as a markdown context cheat-sheet for an ai editor
- describe_text renders the api snapshot as a compact plain-text summary
By LSD Team · Last updated Jul 18, 2026
Ask on Discord
View as Markdown