Authentication

Server-to-server API keys, what the agid_sk prefix means, and where a key may and may not live. There is no browser-safe publishable key on purpose.

Authentication

All SDK requests are authenticated with an API key. Create one from the Settings page in the Vorim AI dashboard.

import createVorim from '@vorim/sdk';

const vorim = createVorim({
  apiKey: 'agid_sk_live_xxxxxxxxxxxxxxxx',
  baseUrl: 'https://api.vorim.ai',  // default
  timeout: 10000,                     // default: 10 seconds
});

typescript

Configuration options:

apiKeystringRequired

Your Vorim AI API key. Starts with agid_sk_.

baseUrlstring

API base URL. Defaults to https://api.vorim.ai.

timeoutnumber

Request timeout in milliseconds. Defaults to 10,000.

Security Note

Never expose your API key in client-side code. The SDK is designed for server-to-server use. Store your key in environment variables.

Need Help?

Book a demo for a walkthrough, or contact us for support. For enterprise needs, reach out at sales@vorim.ai.