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:

​
Required Referer header

Include Referer on every Agent API request, including login, account creation, and calls from a backend or background service. Use your application’s HTTPS URL, for example:
Replace the example with a reachable URL for your application. Keep credentials, tokens, and personal data out of this URL. Referer identifies the calling application; authentication still uses the operation’s required credentials or JWT.
  • Backend and command-line clients: set the header explicitly to your application’s HTTPS URL.
  • Browser clients: the browser manages Referer. Use a referrer policy that sends the application origin, such as strict-origin. In fetch, set referrer: window.location.origin + "/" and referrerPolicy: "strict-origin". For form submissions, configure the page’s Referrer-Policy response header accordingly.
Check the outgoing request in browser developer tools. Browser restrictions can suppress the header; use your backend if the browser cannot send it. See the Fetch request options for browser behavior. Legal Identity application also validates the supplied URL. If it rejects Referer, check that your application’s URL is reachable from the Neuron.

​
HTTP methods

The current Neuron Agent API specification uses POST for most operations. GET /Agent/Account/DomainInfo is the documented exception. Operations with request bodies use JSON.

​
Request structure

Operations inherit JWT bearer authentication unless their OpenAPI entry explicitly overrides security. For bearer-authenticated calls, send:
Several account and session operations explicitly override the global bearer requirement. Login and account creation use HMAC values in the request body. Other anonymous operations have their own request requirements. Check the generated operation before deciding that a request is anonymous. When a documented POST operation has no parameters, its request is still an empty JSON object:

​
Response structure

Documented successful response bodies use JSON when a schema is present. The shape varies per endpoint—see the individual API reference pages. The OpenAPI document does not define a common error body for all operations or complete non-success response set. See Error handling before writing response parsing or retry logic.

​
Federated network

Some operations explicitly document federated behavior, including retrieving or signing contracts created on another Neuron. Do not assume every object or operation supports federation. See Federation for details.