Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.neuro-tech.io/llms.txt

Use this file to discover all available pages before exploring further.

Every token on the Neuron platform is governed by a smart contract that defines a state machine — a set of states and the transitions between them. The State machines endpoints let you query the current state of a token’s state machine and generate detailed reports about its history, structure, and performance. All endpoints require a valid JWT bearer token, and access is subject to the authorization rules of the token’s governing contract.

Endpoints

EndpointDescription
Get current stateRetrieve the current state of the state machine associated with a token.
Create reportGenerate a report about a token’s state machine in a variety of types and formats.

Report types and formats

The Create report endpoint supports multiple report types and output formats:
Report typeDescription
PresentSnapshot of the current state.
HistoryFull log of past state transitions.
StateDiagramVisual diagram of all states and transitions.
ProfilingPerformance and timing data for transitions.
FormatDescription
MarkdownPlain Markdown text.
HtmlRendered HTML.
TextPlain text.
XamlXAML markup (for WPF/UWP).
XamarinXamlXAML markup for Xamarin.
SmartContractSmart contract XML format.
  • Tokens — tokens are the resources that state machines are attached to.
  • Contracts — the smart contracts that define the state machine rules.