API Reference

The Enkelt.ai API provides programmatic access to your organization's data. Use it to build custom integrations, sync data with external systems, or create automated workflows.

All API requests require authentication using a Bearer token. Generate API keys from the Compliance > API Keys section in your dashboard.

Authorization: Bearer sk_live_your_api_key_here

curl -X GET "https://enkelt.ai/api/public/v1/players" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json"

API requests are rate-limited to ensure fair usage and system stability. Limits are applied per API key and reset on a rolling window basis.

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1703275200

The API provides access to the following resources. All endpoints require authentication and respect the permissions assigned to your API key.

All API responses follow a consistent JSON structure. Successful responses include the data and metadata, while errors include error codes and messages.

{
  "success": true,
  "data": {
    "id": "player_abc123",
    "ign": "TenZ",
    "realName": "Tyson Ngo",
    "game": "valorant",
    "role": "duelist",
    "country": "CA",
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "meta": {
    "count": 1,
    "requestId": "req_xyz789",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "status": 429
  }
}

When an error occurs, the API returns an appropriate HTTP status code and a JSON body with details about the error.

API keys can be assigned specific permissions to limit what data they can access. Always use the minimum permissions required for your integration.

Here are examples of how to use the API in popular programming languages.

const response = await fetch('https://enkelt.ai/api/public/v1/players', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key',
    'Content-Type': 'application/json'
  }
});

const { data } = await response.json();
console.log(data); // Array of players

import requests

response = requests.get(
    'https://enkelt.ai/api/public/v1/players',
    headers={
        'Authorization': 'Bearer sk_live_your_api_key',
        'Content-Type': 'application/json'
    }
)

data = response.json()
print(data['data'])  # List of players

• Use environment variables to store your API key, never hardcode it
• Implement exponential backoff when you receive rate limit errors (429)
• Cache responses when possible to reduce API calls
• Use the minimum required permissions for your API key
• Rotate API keys periodically for better security
• Monitor your API usage in the dashboard to avoid hitting limits