Skip to main content

Get API key

To use zkDatabase with the SDK, you need an API Key to authenticate your requests. This guide shows you how to obtain one from the zkDatabase dashboard.

Prerequisites​

  • An Orochi Network account (Orochi ID). If you don't have one, you can sign up during the login process.

Step-by-Step Guide​

1. Log in to the Dashboard​

Navigate to zkDatabase Management tool and log in using your Orochi ID.

2. Navigate to API Keys​

Once logged in, look at the sidebar menu on the left:

  1. Locate the Account section.
  2. Click on API Keys.

API Keys Dashboard

3. Create a New Key​

On the API Keys page:

  1. Click the orange + Create new API key button.
  2. A generic modal will appear.
  3. Enter a descriptive name for your key (e.g., MyProject_Dev).
  4. Select an Expiration period for security (e.g., 30 days, No expiration).
  5. Click Create.

Create Key Modal

4. Copy Your Credentials​

warning

Your Private Key and API Key are shown only once. Copy and store them securely immediately.

After creation, you will see your new credentials. You will typically need:

  • Private Key: The secret key for signing requests.
  • API Key: The public identifier for your application.

Using Your API Key​

Once you have your credentials, you can initialize the ZkDatabase client in your application:

import { ZkDatabase } from "zkdb";

const zkdb = new ZkDatabase({
  url: "https://testnet.zkdatabase.org/graphql", // Verify endpoint
  apiKey: "YOUR_API_KEY",
  // Additional credentials if required by strict auth
});