Authentication

Authentication is required to access any endpoint in the Basalt API. We provide a simple API key-based authentication system to secure your requests. You can find your API key in the Basalt dashboard under API settings.

Get your API key

To get your API key, you need to create an account on the Basalt dashboard. Once you've created an account, you can create an API key from the settings page of your workspace.

Click "Create API key" and define a name for your key.

Your secret key will only be shown once. Always keep it safe and reset it if you suspect it has been compromised.

Using an SDK

To use the Basalt SDK, you need to import the SDK and initialize it with your API key.

// Import the Basalt SDK
import Basalt from '@basalt-ai/sdk'

// Initialize the SDK with your API key
const basalt = new Basalt({ apiKey: "YOUR_API_KEY" })

Using the API

If you don't want to use an SDK, you can use the API directly by adding your API key to the request header as a bearer token.

Example request with bearer token

curl https://api.getbasalt.ai/{endpoint} \
  -H "Authorization: Bearer {token}"