Getting Started

Start building with Opttab's APIs in minutes

What You'll Learn

• How to create an Opttab account
• How to generate and manage API keys
• How to make your first API request
• How to handle authentication and errors

Step 1: Create an Account

Before you can use Opttab's APIs, you'll need to create an account and choose your user type:

Content Creator / Business

Track AI visibility, optimize content, monetize assets, and manage campaigns.

AI Model Developer

Access ethical training data, request custom content, and license datasets.

Create Free Account

Step 2: Generate API Keys

Once logged in, navigate to your dashboard to generate API credentials:

1

Go to Dashboard → API Settings
2

Click "Generate New API Key"
3

Give your key a descriptive name (e.g., "Production API Key")
4

Important: Copy both your API Key and Secret immediately - the secret is only shown once!

Security Best Practice

Store your API credentials securely using environment variables or a secrets manager. Never commit them to version control.

Step 3: Make Your First Request

Test your API credentials with a simple request to check your account status:

cURL Example

curl "https://opttab.com/api/v1/ai/budget-status" \
  -H "X-API-Key: opttab_your_api_key_here" \
  -H "X-API-Secret: your_secret_here"

Python Example

import requests

url = "https://opttab.com/api/v1/ai/budget-status"
headers = {
    "X-API-Key": "opttab_your_api_key_here",
    "X-API-Secret": "your_secret_here"
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)

JavaScript Example

const response = await fetch('https://opttab.com/api/v1/ai/budget-status', {
  headers: {
    'X-API-Key': 'opttab_your_api_key_here',
    'X-API-Secret': 'your_secret_here'
  }
});

const data = await response.json();
console.log(data);

Understanding the Response

All API responses follow a consistent JSON structure:

{
  "success": true,
  "data": {
    "quota_tier": "Starter",
    "rate_limits": {
      "per_minute": 60,
      "per_hour": 1000,
      "per_day": 10000
    },
    "usage": {
      "requests_today": 5,
      "requests_this_hour": 3,
      "requests_this_minute": 1
    }
  }
}

Next Steps

Now that you've made your first request, explore our comprehensive API documentation:

Authentication

Learn about API key authentication, security best practices, and header requirements.

Content Requests API

Create targeted content requests and pay creators for quality submissions.

Asset Monetization

License datasets and content with flexible pricing models (per-use, subscription).

Rate Limiting & Quotas

Understand rate limits, quota tiers, and how to optimize your API usage.