Skip to main content

​
Overview

The Ilumiera AI B2B API uses API key authentication for all endpoints. API keys are managed through the Ilumiera AI dashboard.

​
Getting Your API Key

  1. Sign up at dashboard.getconch.ai
  2. Create your organization in the dashboard
  3. Generate an API key from your dashboard settings
  4. Copy and store your API key securely
Keep your API key secure! Never expose it in client-side code or public repositories.

​
Using Your API Key

All API requests require your API key in the request header:

​
Required Header

api-key: <your-api-key>

​
Example Request

curl -X POST https://b2b-api-backend-95487.ondigitalocean.app/source/ingestSource \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source": {
      "sourceType": "youtube",
      "userId": "user-123",
      "url": "https://www.youtube.com/watch?v=...",
      "metadata": { "topic": "Mathematics" }
    }
  }'

​
JavaScript Example

const response = await fetch(
  "https://b2b-api-backend-95487.ondigitalocean.app/source/ingestSource",
  {
    method: "POST",
    headers: {
      "api-key": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      source: {
        sourceType: "youtube",
        userId: "user-123",
        url: "https://www.youtube.com/watch?v=...",
        metadata: { topic: "Mathematics" },
      },
    }),
  }
);

​
Python Example

import requests

headers = {
    'api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
}

data = {
    'source': {
        'sourceType': 'youtube',
        'userId': 'user-123',
        'url': 'https://www.youtube.com/watch?v=...',
        'metadata': {'topic': 'Mathematics'}
    }
}

response = requests.post(
    'https://b2b-api-backend-95487.ondigitalocean.app/source/ingestSource',
    headers=headers,
    json=data
)

​
API Key Security Best Practices

​
Store Keys Securely

  • Environment Variables: Always store API keys in environment variables
  • Never Commit: Add .env files to .gitignore
  • Server-Side Only: Only use API keys in server-side code
  • Rotate Regularly: Periodically rotate your API keys from the dashboard

​
Example: Using Environment Variables

// .env file
CONCH_AI_API_KEY = your - api - key - here;

// Your application code
const apiKey = process.env.CONCH_AI_API_KEY;

const response = await fetch(url, {
  headers: {
    "api-key": apiKey,
    "Content-Type": "application/json",
  },
});

​
Error Responses

​
Missing API Key

{
  "error": "API key is required"
}

​
Invalid API Key

{
  "error": "Invalid API key"
}

​
Unauthorized Access

{
  "error": "Not authorized to access this resource"
}

​
API Key Management

All API key management operations are performed through the Ilumiera AI dashboard:
  • View API Keys: See all your active API keys
  • Generate New Keys: Create additional API keys for different environments
  • Revoke Keys: Immediately disable compromised or unused keys
  • Monitor Usage: Track API key usage and rate limits
Visit dashboard.getconch.ai to manage your API keys.

​
Rate Limiting

Rate limiting may be applied per API key. See the Rate Limits page for more information.

​
Support

If you’re having issues with authentication:
  1. Verify your API key is correct and active in the dashboard
  2. Check the header name is exactly api-key (lowercase)
  3. Ensure HTTPS is being used for all requests
  4. Contact support at [email protected] if issues persist