HelixDB Docs

Tutorial

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

Use the Helix Cloud dashboard to organize databases into workspaces and projects, choose a managed plan, 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

Enter a workspace name, select the region for future dedicated clusters, and select Create Workspace.

New workspaces currently support only the us-east-1 region.

Create a Workspace form with workspace name and region fields

Create a project

Select Create Project, then give the project a name. Projects group the databases and dedicated clusters for an application or environment.

Helix Cloud project list with the Create Project action

Start creating a database

Open the project and select Create Database.

Empty project with options to create a database or deploy a dedicated cluster

Choose a name and plan

Keep Database selected, enter a database name, choose a monthly plan, and select Create Database. The plan determines the included read and write query allowance.

Create Database form with database name and monthly plan options

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 endpoint, database ID, API keys, and query insights

Test the connection

Set the three values copied from the database page, then send this read-only query. It counts User nodes, so it also succeeds on a new database with a count of 0.

export HELIX_ENDPOINT="https://<cluster>.cluster.helix-db.com"
export HELIX_DATABASE_ID="<database-id>"
export HELIX_API_KEY="<api-key>"

curl --fail-with-body --silent --show-error \
  "$HELIX_ENDPOINT/v2/query" \
  --header "Authorization: Bearer $HELIX_API_KEY" \
  --header "x-helix-tenant-id: $HELIX_DATABASE_ID" \
  --header "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "request_type": "read",
  "query_name": "connection_test",
  "query": {
    "read": {
      "entries": [
        {
          "query": {
            "name": "user_count",
            "root": {
              "count": {
                "input": {
                  "nodes_where": {
                    "predicate": {
                      "eq": {
                        "left": { "property": "$label" },
                        "right": { "constant": { "string": "User" } }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      ],
      "returns": ["user_count"]
    }
  }
}
JSON

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.

Start Here

Operate

Using the Dashboard

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