Sandbox — LSD is in active testing. All systems operational·payments are test-mode (no real charges).

Overview Use Cases News Docs Tool Store Support Community Get LSD

All docs

Docs/ API Reference/ describe_api/ describe_text

describe_api· function

describe_text

renders the api snapshot as a compact plain-text summary

Python

describe_text(data: Optional[Dict[str, Any]] = None) -> str

Returns str — a short plain-text human summary of the snapshot

Parameters#

name	type	default	description
`data`	`Optional[Dict[str, Any]]`	`None`	a snapshot from `describe_api()`; recomputed fresh when omitted

Example#

Python

from lsdtools.advanced import describe_text

print(describe_text())

Pass an existing snapshot to avoid re-introspecting:

Python

from lsdtools import describe_api
from lsdtools.advanced import describe_text

snap = describe_api()
print(describe_text(snap))

Notes#

Lives in lsdtools.advanced, not the top-level surface. When data is omitted it calls describe_api() itself. The output lists the api_version / lsd_version, a public-surface count, then each step (tagged with its kind) and entity with their required and optional parameter names — a human summary, not machine-readable JSON.

Parameters#

Example#

Notes#

See also#