Quickstart - Neuron Agent API

This guide walks you through creating an account and making your first authenticated request to the Neuron Agent API.

Prerequisites

Access to a Neuron host (domain name issued by your Neuron operator)
An API key and secret issued for your Neuron (obtained via your operator or the onboarding process)

Step 1: Get your domain and credentials

The Neuron Agent API is served from your specific Neuron domain. All endpoints are relative to:

https://{host}

Where {host} is the Neuron domain you were issued credentials for. Your operator will also provide you with an API key and API secret for account creation.

Step 2: Create an account

Account creation uses HMAC-signed requests. See Authentication for full signing details.

curl -X POST https://{host}/Agent/Account/Create \
  -H "Content-Type: application/json" \
  -d '{
    "userName": "myaccount",
    "eMail": "user@example.com",
    "password": "...",
    "apiKey": "YOUR_API_KEY",
    "nonce": "UNIQUE_NONCE",
    "signature": "HMAC_SIGNATURE"
  }'

A successful response includes an initial JWT token.

Step 3: Log in and get a JWT

After verifying your email, log in to receive a JWT for subsequent requests:

curl -X POST https://{host}/Agent/Account/Login \
  -H "Content-Type: application/json" \
  -d '{
    "userName": "myaccount",
    "nonce": "UNIQUE_NONCE",
    "signature": "HMAC_SIGNATURE",
    "seconds": 3600
  }'

Step 4: Make authenticated requests

Include your JWT in the Authorization header for all subsequent calls:

curl -X POST https://{host}/Agent/Account/Info \
  -H "Authorization: Bearer YOUR_JWT"

Next steps

Read Authentication for full details on HMAC signing and JWT usage.
Read API Basics to understand the request/response model.
Follow the User onboarding guide for a complete step-by-step walkthrough.

​Prerequisites

​Step 1: Get your domain and credentials

​Step 2: Create an account

​Step 3: Log in and get a JWT

​Step 4: Make authenticated requests

​Next steps