neuronum 2026.6.2

Neuronum SDK

Neuronum SDK

---

About

Neuronum enables business partners to connect their distributed AI agents and communicate across devices through a Secure Agent Session (SAS). The framework provides built‑in end‑to‑end encryption, identity management, and message delivery through simple function calls.

⚠️ Development Status: The Neuronum SDK is currently in beta and is not production-ready. It is intended for development, testing, and experimental purposes only. Do not use in production environments or for critical applications.

---

Requirements

• Python >= 3.8

---

Installation

Set up and activate a virtual environment:

python3 -m venv ~/neuronum-venv
source ~/neuronum-venv/bin/activate

Install the Neuronum SDK:

pip install neuronum

Note: Always activate this virtual environment (source ~/neuronum-venv/bin/activate) before running any neuronum commands.

---

Cell

A Cell is your address used to send and receive data on the Neuronum network. You can think of it like a unique digital identity.

Example IDs: acme.com::cell [e-mail]::cell

Create a Cell:

neuronum create-cell

This generates your Cell ID, public/private key pair, and a 12-word mnemonic recovery phrase. Your Cell credentials are stored locally at ~/.neuronum/.env.

Connect your Cell to a device using your 12-word mnemonic:

neuronum connect-cell

View the connected Cell ID:

neuronum view-cell

Disconnect Cell credentials from this device:

neuronum disconnect-cell

Delete your Cell permanently from the network:

neuronum delete-cell

---

Methods

Cells interact using five methods:

Method	Description
list_cells()	List all Neuronum Cells
list_sessions()	List your Secure Agent Sessions (SAS)
create_secure_agent_session(cell_id or email_address)	Create and invite to a session
send_session_message(session_id, data)	Send an encrypted message to a session
get_session_messages(session_id)	Fetch and decrypt messages from a session

All data is end-to-end encrypted. The network handles routing, key exchange, and delivery. You just send and receive.

Connecting to the network: Use async with Cell(network="testnet.neuronum.net") as cell to connect. This reads your Cell credentials from ~/.neuronum/.env and establishes a connection to the specified Neuronum network. Omitting the network parameter defaults to testnet.neuronum.net.

---

Quick Examples

List Cells

import asyncio
from neuronum import Cell

async def main():
    async with Cell(network="testnet.neuronum.net") as cell:
        cells = await cell.list_cells()
        print(cells)

asyncio.run(main())

List Sessions

import asyncio
from neuronum import Cell

async def main():
    async with Cell(network="testnet.neuronum.net") as cell:
        sessions = await cell.list_sessions()
        print(sessions)

asyncio.run(main())

Create a Secure Agent Session

import asyncio
from neuronum import Cell

async def main():
    async with Cell(network="testnet.neuronum.net") as cell:
        session = await cell.create_secure_agent_session(
            receiver_cell_id="receiver.com::cell"
        )
        print(session)

asyncio.run(main())

Send a message to a session

import asyncio
from neuronum import Cell

async def main():
    async with Cell(network="testnet.neuronum.net") as cell:
        success = await cell.send_session_message(
            "session_id",
            {"msg": "Hello"}
        )
        print(success)

asyncio.run(main())

Fetch messages from a session

import asyncio
from neuronum import Cell

async def main():
    async with Cell(network="testnet.neuronum.net") as cell:
        async for tx in cell.get_session_messages("session_id"):
            print(tx)

asyncio.run(main())

---

TX (Transmitter) Object

When you fetch data via get_session_messages, each payload arrives as a TX object:

{
    "tx_id": "bfd2a0d009c6f784ec97c41d3738a24e0e5ac8f1",
    "time": "1772923393",
    "sender": "acme.com::cell",
    "data": {
        "msg": "Hello World!",
        "public_key": "-----BEGIN PUBLIC KEY-----\n..."
    }
}

Field	Description
tx_id	Unique payload ID generated from the encrypted data context and timestamp
time	Unix timestamp of the transmission
sender	The sender's Cell ID
data	The decrypted payload, including the sender's public key

---

Full Documentation

For the complete SDK reference including the E2EE protocol, visit the Neuronum Docs.