Quickstart
This quickstart takes you from zero to a working Neumera integration using the hosted API.
You will: request a sandbox key, create a session, step the session, inspect runtime summary, and inspect world state.
1. Request sandbox access
Request a sandbox key through the public access route.
curl -X POST https://api.neumera.io/v1/access/request \
-H "Content-Type: application/json" \
-d '{
"name": "Example Builder",
"email": "builder@example.com",
"intended_use": "Prototype a persistent research assistant"
}'{
"api_key": "nm_sandbox_xxxxxxxxxxxxx",
"entitlement": "sandbox",
"access_layer": "layer0_public",
"limits": {
"requests_per_minute": 60,
"daily_quota": 1000
}
}Store the key securely. Include it in the X-API-Key header on authenticated requests.
2. Create a session
Create a session to begin a persistent interaction.
curl -X POST https://api.neumera.io/v1/sessions \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"continuity_mode": "preserve"
}'{
"ok": true,
"payload": {
"session_id": "sess_123",
"created_at": "2026-04-14T12:00:00Z"
}
}3. Step the session
Step the session with a real input.
curl -X POST https://api.neumera.io/v1/sessions/sess_123/step \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"input_packet": {
"command": "summarize_state",
"args": {
"focus": "next_best_action"
}
}
}'{
"ok": true,
"payload": {
"session_id": "sess_123",
"output": "Current state has been summarised.",
"summary_ref": "sum_456"
}
}4. Inspect runtime summary
curl -X GET https://api.neumera.io/v1/runtime/summary?session_id=sess_123 \
-H "X-API-Key: YOUR_API_KEY"{
"ok": true,
"payload": {
"session_id": "sess_123",
"state": "active"
}
}5. Inspect world state
curl -X GET https://api.neumera.io/v1/worlds/state \
-H "X-API-Key: YOUR_API_KEY"{
"ok": true,
"payload": {
"world_state": {
"objects": [],
"history_head": "evt_001"
}
}
}Next steps
From here, most builders move in one of four directions:
- richer session loops
- world-state integration
- external event ingestion
- evidence and governed-action flows