Quickstart
This page takes you from nothing to a working query against NamiDB Cloud in a few minutes. To run the engine yourself instead, see Self-hosted.
1. Create an account and an organization
-
Go to app.namidb.com/signup. Sign up with your name, email and a password (at least 10 characters), or with GitHub or Google when they are offered.
-
Confirm your address. The email carries a link and a 6-digit code; either one works, once, for 15 minutes.
-
Name your organization. The organization is your workspace: it owns the databases, API keys, members and billing. You can also pick where its storage lives, or keep the default (closest to you).
New organizations start on the Free plan. Nothing is charged until an owner picks a paid plan and completes checkout. See Billing.
2. Create a database
In the console, open Databases → Create database and name it movies.
Names use lowercase letters, numbers, - and _, start with a letter or a
number, and are at most 63 characters.
The database page opens on its Connect tab, which shows the HTTPS endpoint and the Bolt URI with ready-to-copy snippets. An empty database also offers Load sample dataset in the Query tab: a small movies graph you can try queries on.
3. Create an API key
Open API keys → Create key:
- Name: something that says where it is used, such as
quickstart. - Access: Read & write for this guide. Use Read only for anything that only reads.
- Databases: All databases, or only
movies. - Expires: 90 days by default.
The key looks like nmdb_live_… and is shown once. Copy it into an
environment variable now:
export NAMIDB_API_KEY=nmdb_live_…NamiDB stores only a keyed hash of it. If you lose it, revoke it and create a new one. More in API keys and management tokens.
4. Run your first query
curl https://db.namidb.com/v1/movies/cypher \ -H "Authorization: Bearer $NAMIDB_API_KEY" \ -H "Content-Type: application/json" \ -d '{"query": "CREATE (:Movie {title: $title, released: $year})", "params": {"title": "Heat", "year": 1995}}'
curl https://db.namidb.com/v1/movies/cypher \ -H "Authorization: Bearer $NAMIDB_API_KEY" \ -H "Content-Type: application/json" \ -d '{"query": "MATCH (m:Movie) RETURN m.title AS title, m.released AS year"}'{"columns": ["title", "year"], "rows": [{"title": "Heat", "year": 1995}]}npm install @namidb/cloudimport { NamiDB } from '@namidb/cloud';
const db = new NamiDB(); // reads NAMIDB_API_KEY
await db.query('movies', 'CREATE (:Movie {title: $title, released: $year})', { title: 'Heat', year: 1995,});
const { rows } = await db.query<{ title: string; year: number }>( 'movies', 'MATCH (m:Movie) RETURN m.title AS title, m.released AS year',);console.log(rows); // [ { title: 'Heat', year: 1995 } ]Runs on Node 18+, Deno, Bun and edge runtimes. See the JavaScript SDK reference.
pip install namidb-cloudfrom namidb_cloud import NamiDB
db = NamiDB() # reads NAMIDB_API_KEY
db.query("movies", "CREATE (:Movie {title: $title, released: $year})", {"title": "Heat", "year": 1995})
result = db.query("movies", "MATCH (m:Movie) RETURN m.title AS title, m.released AS year")for row in result: print(row["title"], row["year"]) # Heat 1995Python 3.9+. An asyncio client is included. See the Python SDK reference.
pip install neo4jimport osfrom neo4j import GraphDatabase
# Any username works: the API key is the password.auth = ("namidb", os.environ["NAMIDB_API_KEY"])with GraphDatabase.driver("neo4j+s://db.namidb.com:7687", auth=auth) as driver: driver.execute_query( "CREATE (:Movie {title: $title, released: $year})", title="Heat", year=1995, database_="movies", ) records, _, _ = driver.execute_query( "MATCH (m:Movie) RETURN m.title AS title, m.released AS year", database_="movies", ) print([r.data() for r in records])Java, Go, .NET and JavaScript drivers work the same way: see Bolt and Neo4j drivers.
The first query after a quiet period can take a moment while the database wakes up. The SDKs and drivers wait for it; see Scale to zero.
5. Look at it in the console
Open the database’s Query tab and run:
MATCH (m:Movie) RETURN mSwitch the result to Graph to see the nodes, or Table and JSON for the raw values. The Metrics tab shows reads and writes as they happen, and Usage shows them against your plan’s allowance.
Next steps
- Concepts: organizations, roles, databases, keys and plans.
- Import data from CSV or JSON.
- Connect an AI agent over MCP.
- Automate with the management API.
- Learn the Cypher NamiDB supports.