Skip to main content
Tutorial
Use Helix Cloud to create a workspace, choose a monthly plan shared by its databases, provision a database, and create API keys. Helix Cloud runs in the AWS us-east-1 (N. Virginia) region.
1

Sign in

Open the Helix Cloud dashboard and sign in with GitHub or with your email and password. When prompted, enter the one-time verification code from the email sent by WorkOS.
Helix Cloud login page with the GitHub Login button
2

Create a workspace and choose a plan

Enter a workspace name, choose a monthly plan, and select Create workspace. The plan’s read and write allowances are shared by every database in the workspace. You can change the plan later from Billing.
Create a workspace form with workspace name and monthly plan options
3

Create a database

Enter a database name and select Create Database. Helix Cloud generates its URL slug. The database has isolated data and uses the workspace’s shared monthly allowance. Database creation creates a default read-write API key and displays its token once. Save it immediately in the application’s secrets manager; Helix cannot show it again.
Create a Database form with a database name field
4

Copy the connection details

Open the database. In Connect, copy the endpoint and database ID. To connect an application directly to the gateway, create a read-only or read-write key in API Keys and copy its value, which is shown once. A new key can return 401 for its first few seconds; retry shortly.
Active database details page with connection details, workspace plan, API keys, and query insights

Test the connection

Set the three values copied from the database page, then count the database’s nodes. A successful response, such as {"node_count":0}, confirms the connection.
To test the Cypher route, send the equivalent statement to /v2/cypher with the same headers; an empty database returns {"columns":["node_count"],"rows":[[0]]}.
SQL works the same way at /v2/sql, for example with {"query":"SELECT count(*) AS people FROM Person p"}. Keep API keys in a secrets manager or environment variable. Do not commit them to source control.

Next steps

Connect an application

Connect from an SDK and understand Cloud request routing.

Security

Review authentication, encryption, and API key handling.

TypeScript SDK setup

Install the SDK and connect a Node.js application.

Query walkthrough

Build and run a query step by step.