Skip to main content

​
Base URL

All API requests are made to your Neuron’s domain:
Where {host} is the Neuron domain issued to you by your operator. There is no shared central URL — each Neuron deployment has its own domain. All endpoints are prefixed with /Agent/. For example:

​
HTTP methods

The Neuron Agent API uses POST for all operations. Request bodies are JSON.

​
Request structure

All authenticated requests must include a JWT bearer token:
For account creation and login, the Authorization header is not used — authentication is provided via HMAC signing in the request body instead. See Authentication for details.

​
Response structure

Responses are returned as JSON. The shape varies per endpoint — see the individual API reference pages for response schemas. Errors are indicated by HTTP status codes (4xx, 5xx) and include a JSON error body. See Error handling for details.

​
Federated network

Neurons are federated — some operations (such as contract signing and Quick Login) can target remote Neurons in the network. In those cases the endpoint routes the request appropriately using the federated XMPP infrastructure.