Skip to main content

​
Getting an API Key

An access key is required to use the Neuradex API.
Neuradex is currently in Closed Beta. Please join the Waitlist to request access.
1

Log in to the Dashboard

Log in to the Neuradex Dashboard.
2

Select a Project

Select or create a new project.
3

Create an Access Key

Go to Settings → Access Keys and create a new key.
The access key is only displayed once. Save it in a secure location.

​
Client Initialization

​
Global Client

Use the global client when accessing multiple projects. 
import { NdxGlobalClient } from '@neuradex/sdk';

const global = new NdxGlobalClient({
  apiKey: process.env.NEURADEX_API_KEY,
});

// Get project list
const projects = await global.listProjects();

// Get client for a specific project
const client = global.getProject('project-id');

​
Project Client

For single project use, initialize the project client directly. 
import { NdxClient } from '@neuradex/sdk';

const client = new NdxClient({
  apiKey: process.env.NEURADEX_API_KEY,
  projectId: 'your-project-id',
});

​
Verifying Authentication

After client initialization, verify that authentication is correctly configured. 
const result = await global.verifyAuth();

if (result.valid) {
  console.log('Authentication successful');
} else {
  console.error('Authentication failed:', result.error);
}

​
Environment Variables

We recommend managing API keys with environment variables.
.env
NEURADEX_API_KEY=ndx_your_api_key_here
NEURADEX_PROJECT_ID=your-project-id
For production environments, we recommend using secret management services (AWS Secrets Manager, Vercel Environment Variables, etc.).

​
Next Step

Quickstart

Register your first knowledge