HelixDB Docs

Tutorial

For the complete documentation index optimized for AI agents, see llms.txt.

Use Helix Cloud to create a workspace, choose a monthly plan shared by its databases, provision a database, and create API keys.

Open the Helix Cloud dashboard and select GitHub Login. When prompted, enter the one-time verification code from the email sent by WorkOS.

Helix Cloud login page with the GitHub Login button

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

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.

Copy the connection details

Wait for the database status to become Active, then open it. In Connect, copy the endpoint and database ID. In API Keys, create a key or use an existing one and copy its value when it is shown.

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.

export HELIX_ENDPOINT="<endpoint>"
export HELIX_DATABASE_ID="<database-id>"
export HELIX_API_KEY="<api-key>"

curl --fail-with-body \
  "$HELIX_ENDPOINT/v2/query" \
  --header "Authorization: Bearer $HELIX_API_KEY" \
  --header "x-helix-tenant-id: $HELIX_DATABASE_ID" \
  --header "Content-Type: application/json" \
  --data '{
    "request_type": "read",
    "query": {
      "read": {
        "entries": [
          {
            "query": {
              "name": "node_count",
              "root": {
                "count": {
                  "input": {
                    "nodes": { "reference": "all" }
                  }
                }
              }
            }
          }
        ],
        "returns": ["node_count"]
      }
    }
  }'

Keep API keys in a secrets manager or environment variable. Do not commit them to source control.

Next steps

Helix Cloud overview

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.

⌘I

Start Here

Connect and automate

Operate

Using the Cloud

Test the connection

Next steps

Helix Cloud overview

Security

TypeScript SDK setup

Query walkthrough

​Test the connection

​Next steps

Helix Cloud overview

Security

TypeScript SDK setup

Query walkthrough

Test the connection

Next steps