API Documentation

Overview

Our API provides protected endpoints that require API key authentication. Each user can generate multiple API keys with different rate limits based on their subscription tier.

Authentication

All API requests must include an API key in the Authorization header:

Authorization: Bearer sk_your_api_key_here

Rate Limits

Rate limits are based on your subscription tier:

PlanDaily Requests
FREE1,000
PRO10,000
ENTERPRISE100,000

Endpoints

Base URL

https://your-domain.com/api/v1

GET /data

Returns user information and API key details.

curl -H "Authorization: Bearer sk_your_api_key_here" \
     https://your-domain.com/api/v1/data

POST /data

Processes data with subscription-based features.

curl -X POST \
     -H "Authorization: Bearer sk_your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{"data": "Hello World", "options": {"feature": "test"}}' \
     https://your-domain.com/api/v1/data

Getting Started

  1. Sign up for an account and choose a subscription plan
  2. Go to your dashboard and create an API key
  3. Copy the API key (it's only shown once!)
  4. Use the API key in your requests

Need Help?

Check out the complete API documentation in the API_DOCUMENTATION.md file for detailed examples and error handling.

Test Your API

Use the test-api.js script to test your API endpoints locally.