Skip to main content
The Neuron Agent API exposes core Neuron platform functionality over HTTP, allowing services to interact with accounts, identities, contracts, tokens, messaging, and more — without requiring a persistent XMPP connection. All endpoints follow a consistent request/response model. See API basics, Authentication, and Pattern matching for the foundations.

​
Base URL

Use the Neuron domain you were issued credentials for. Replace {host} with your Neuron server domain in all requests.

​
Authentication

Most endpoints require a JWT bearer token passed in the Authorization header:
Obtain a token via Login or Create account. Some endpoints also require HMAC-signed requests — see the Authentication guide for details.

​
Endpoint groups

​
Accounts & onboarding

Create and manage Neuron accounts, verify email and phone, recover access, and transfer accounts to other applications.

​
Authentication & sessions

Log in, refresh tokens, authenticate JWTs, and manage session flows including Quick Login and WWW-Authenticate.

​
Messaging

Send text and formatted XMPP messages, manage presence subscriptions, probe contacts, and maintain your roster. Apply for legal identities, attach supporting documents, request peer or service review, and petition for signatures or identity access.

​
Contracts

Create and propose smart contract templates, send proposals to counterparties, sign contracts, and manage access authorization.

​
Wallet

Query eDaler balances, process eDaler URIs, and initiate buy/sell flows through available service providers.

​
Tokens

Inspect token metadata, query token events, retrieve creation attributes, and add text or XML notes to tokens.

​
State machines

Query the current state of a token’s state machine and generate transition reports in multiple formats.

​
Storage

Save and load private XML, manage encrypted vault items, search vault contents, and create shareable vault links.

​
Cryptography

Discover available cryptographic algorithms, create signing keys, and retrieve server or account public keys.

​
Open intelligence

Publish, query, update, and delete open intelligence records about endpoints, and check endpoint status.

​
OpenAPI / playground

Explore and test all endpoints interactively using the built-in OpenAPI playground.