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.
What is the Neuron API?
The Neuron API is the HTTP interface to the Neuron — the central server node of the Neuro platform. It lets trusted back-end services interact with the full range of Neuron capabilities without requiring a persistent XMPP connection. Through the API you can onboard users, authenticate sessions, manage legal identities, create and sign smart contracts, handle tokenized assets and state machines, send XMPP messages, and store encrypted data in the vault — all over standard HTTPS requests with JWT bearer token authentication.The Neuron API is designed for trusted back-end clients that can securely store API keys and secrets. If you need browser-based account creation, use the Create web form endpoint instead.
What you can build
- Identity-verified applications — onboard users, apply for legal identities, and attach cryptographic signatures to documents and contracts
- Smart contract workflows — create contract templates, propose and collect signatures from multiple parties, and track contract state
- Token management — query and annotate tokenized assets linked to smart contracts and state machines
- Secure messaging — send text and rich XMPP messages, manage rosters and presence, and register event handlers
- Encrypted storage — save private XML data and vault items with masking, search, and shareable links
- Cryptographic operations — discover algorithms, create signing keys, and retrieve public keys for validation
Get started
Quickstart
Make your first API call in minutes.
Authentication
Learn how JWT tokens and HMAC signing work.
API reference
Browse all endpoint groups and operations.
Guides
Follow step-by-step integration flows.
How the API is structured
All endpoints are grouped by capability under a common base URL:{host} is the Neuron domain you were issued credentials for.
| Group | Description |
|---|---|
| Accounts & onboarding | Create accounts, verify email/phone, recover access |
| Authentication & sessions | Login, refresh, Quick Login, JWT validation |
| Messaging | Send messages, manage presence and rosters |
| Legal identities | Apply for IDs, attach evidence, request approval |
| Contracts | Create, propose, and sign smart contracts |
| Wallet | Query balances, process eDaler URIs, buy/sell flows |
| Tokens | Inspect token metadata, events, and notes |
| State machines | Query state and generate transition reports |
| Storage | Private XML, encrypted vault, content hosting |
| Cryptography | Algorithms, signing keys, public keys |
| Open intelligence | Publish and query endpoint intelligence records |
Core concepts
- JWT authentication — most endpoints require a short-lived JWT obtained via Login. Tokens must be refreshed before expiry.
- HMAC signing — account creation and login use HMAC-signed requests to prove ownership of the API key without transmitting secrets.
- Pattern matching — request and response schemas use a readable notation for required/optional fields. See Pattern matching for a full reference.
- Federated network — Neurons are federated. Some operations (e.g. contract signing, Quick Login) can target remote Neurons in the network.
Reference
- API basics — base URL, HTTP methods, request structure
- Content types — supported formats and encoding
- Error handling — status codes and common failure modes
- Security and transport — TLS, rate limits, and best practices
- Versioning — how API versions are managed and deprecated