Quickstart

The current dashboard connect flow is organized into three steps.

1. Install a TigerBeetle client

The UI currently provides examples for:

• Node.js
• Go
• Java
• .NET
• Python

The Node.js example installs the Parix package:

npm install @parix/tigerbeetle-node

2. Configure the connection

Generate an API key from Settings > API keys. Secret values are shown once, so save the key in your environment:

export PARIX_API_KEY="px_..."

The current dashboard examples authenticate through the Parix API with the x-api-key header:

const response = await fetch('https://dev.parix.io/api/v1/databases/<database-id>', {
  headers: {
    'x-api-key': process.env.PARIX_API_KEY ?? '',
  },
});

3. Verify the connection

Run a lightweight lookup through the generated client example, or call the HTTP TigerBeetle route directly:

curl -X POST "https://dev.parix.io/api/v1/databases/<database-id>/tb/query_accounts" \
  -H "content-type: application/json" \
  -H "x-api-key: $PARIX_API_KEY" \
  -d '{"limit":100,"flags":0}'

Notes

• API keys can be scoped to all databases or one specific database
• read operations require db:read
• write operations require db:write
• for HTTP-native access patterns, see Gateway