Skip to Content
🎉 New release with new features and improvements! V0.0.6 Release →
DocumentationsBsh EngineSDKAuthenticationAPI Key

API Key Authentication

The simplest way to authenticate is using an API key:

const bshEngine = new BshEngine({
  host: 'https://your-instance.com',
  apiKey: 'your-api-key'
});

The SDK sends the key on every request as Authorization: <your-api-key>. See Using your API key.

Integrations built for engine 0.0.5 and earlier may still send X-BSH-APIKEY. That header is deprecated as of 0.0.6; migrate to the SDK default or set Authorization manually.

API KeyCustom Auth