Overview - Neuron Agent API

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

Endpoint	Description
Get current state	Retrieve the current state of the state machine associated with a token.
Create report	Generate 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 type	Description
`Present`	Snapshot of the current state.
`History`	Full log of past state transitions.
`StateDiagram`	Visual diagram of all states and transitions.
`Profiling`	Performance and timing data for transitions.

Format	Description
`Markdown`	Plain Markdown text.
`Html`	Rendered HTML.
`Text`	Plain text.
`Xaml`	XAML markup (for WPF/UWP).
`XamarinXaml`	XAML markup for Xamarin.
`SmartContract`	Smart contract XML format.

Tokens — tokens are the resources that state machines are attached to.
Contracts — the smart contracts that define the state machine rules.

​Endpoints

​Report types and formats

​Related

Endpoints

Report types and formats

Related