Authentication

Authenticate your requests to the Sentrial API.

API Keys

Sentrial uses API keys to authenticate requests. Your API keys carry many privileges, so be sure to keep them secure and never expose them in client-side code.

Getting Your API Key

1. 1
   Sign in to your Sentrial dashboard
2. 2
   Navigate to Settings → API Keys
3. 3
   Click "Generate New Key"
4. 4
   Copy and securely store your API key (it will only be shown once)

Authentication Methods

Authorization: Bearer your-api-key-here

curl https://api.realm.ai/v1/sessions \
  -H "Authorization: Bearer your-api-key-here" \
  -H "Content-Type: application/json"

from sentrial import SentrialClient

client = SentrialClient(
    api_key="your-api-key-here",
    project_id="your-project-id"
)

import { SentrialClient } from '@sentrial/sdk';

const client = new SentrialClient({
  apiKey: 'your-api-key-here',
  projectId: 'your-project-id'
});

Environment Variables

Store credentials in environment variables to keep them secure:

# .env
SENTRIAL_API_KEY=your-api-key-here
SENTRIAL_PROJECT_ID=your-project-id

from sentrial import SentrialClient

# Automatically uses SENTRIAL_API_KEY and SENTRIAL_PROJECT_ID
client = SentrialClient()

import { SentrialClient } from '@sentrial/sdk';

// Automatically uses process.env.SENTRIAL_API_KEY
const client = new SentrialClient();

Error Responses

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "API key does not have access to this project"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Retry after 60 seconds.",
    "retry_after": 60
  }
}

Rate Limits

Rate limits are enforced per API key. Contact us for higher limits.