API Keys

Use API keys to securely connect your RIXL project with applications, workflows, or services. Each key is project-scoped for security and can be configured with permissions.

Quick Actions

Create API Key

Generate a new secure key for this project.

View Documentation

Complete API reference and integration examples.

Account Settings

Manage all your API keys across projects.

Benefits of API Keys

Project Isolation

Each key is tied to a single project

Granular Permissions

Control upload, read, and analytics access

Usage Analytics

Monitor API calls and performance

Enterprise Security

Rotate keys and set expiration dates

Create Your First API Key

Navigate to API Settings

In your project dashboard, go to Settings → API Keys → Create New Key.

Configure Permissions

Set permissions based on your use case:

Full Access: Upload, read, and manage all content
Upload Only: Create and upload new media
Read Only: Access existing content and analytics
Custom: Define specific endpoint permissions

Copy Your Key

Save your API key immediately — it's shown once only.

X-API-Key: YOUR_PROJECT_API_KEY_HERE

Test Integration

Use the key in your first API request to verify setup.

Security Note: API keys act like project passwords. Store them securely and never commit them to version control.

Integration Examples

Authentication Header

curl -H "X-API-Key: YOUR_PROJECT_API_KEY" https://api.rixl.com/videos

JavaScript Fetch

const response = await fetch('https://api.rixl.com/videos', {
  headers: {
    'X-API-Key': 'YOUR_PROJECT_API_KEY'
  }
});

Key Management

Security Best Practices

Rotate Regularly: Update keys every 90 days
Use Environment Variables: Store keys in environment variables, not code
Monitor Usage: Watch for unexpected API activity
Limit Permissions: Give keys only the access they need

Troubleshooting

401 Unauthorized: Key is missing, invalid, or expired
403 Forbidden: Key doesn't have required permissions
Rate Limited: Too many requests — slow down or upgrade

Need help? See our API troubleshooting guide or contact support.

API Access Settings - Complete API key management
API Reference - Full API documentation
Project Settings - Project-specific configurations

API Key Management

Key Information

API Key ID: Unique identifier
Name: Descriptive label
Project: Linked project (if scoped)
Created Date: Timestamp

Expiration Date: When key expires (if set)
Status: Active, Expired, or Revoked
Last Used: Most recent API call

Total Calls: Number of API requests
Success Rate: Percentage of successful requests
Rate Limit: Usage against plan limits

Management Actions

View Details

Check usage statistics, activity logs, and permission reviews

Update Settings

Modify key name, expiration date, and project associations

Revoke Access

Immediately disable API key and prevent further calls (irreversible)

Security Best Practices

Follow these practices to maintain API key security and organization efficiency.

Security Guidelines:

Use descriptive names to identify each key's purpose
Set reasonable expiration dates based on usage patterns
Regularly audit and clean up unused keys
Never share API keys in public repositories or forums
Use different keys for different applications or environments

Organization Standards:

Create separate keys for production and development
Use project-specific keys when possible
Document the purpose of each key
Monitor usage patterns for unusual activity

Permission System

Project-Scoped Keys

Best for individual projects with limited access.

Isolated access to one project
Easier auditing and monitoring
Lower risk if compromised

Organization-Level Keys

Capabilities:

Access to all projects within the organization
Create and manage projects and teams
Billing and usage management

Permission Levels

View project information
Access media files
Check feed and usage statistics

All read-only permissions
Upload media files
Create and modify feeds
Update project settings

All read-write permissions
Manage team members
Create and revoke API keys
Access billing information

Monitoring & Analytics

Rate Limits by Plan

Free Plan

100 API calls per hour

Pro Plan

1,000 API calls per hour

Enterprise Plan

Custom API limits tailored to your needs

Monitoring Dashboard

Real-time Metrics:

Total API calls
API call trends per period (hour, day, month)
Most active keys
Error rates and response times

Analytics Features:

Successful requests vs. errors
Response time trends
Most frequently used endpoints
Geographic distribution of requests

Usage Alerts

Configure alerts to stay informed about your API usage patterns and to avoid unexpected alerts and misuse.

Set up notifications for:

High-usage patterns detected
Rate limit warnings
Unusual activity or potential security issues
API Key expiration warnings

Integration Workflows

Authentication Structure

curl -X GET "https://api.rixl.com/videos" \
  -H "X-API-Key: YOUR_PROJECT_API_KEY" \
  -H "Content-Type: application/json"

Common API Operations

curl -X POST "https://api.rixl.com/videos/upload/init" \
-H "X-API-Key: YOUR_PROJECT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"file_name": "my-video.mp4",
"video_quality": "shorts",
"image_format": "jpg"
}'

curl -X POST "https://api.rixl.com/images/upload/init" \
-H "X-API-Key: YOUR_PROJECT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "my-image.jpg",
"format": "jpg"
}'

curl -X GET "https://api.rixl.com/feeds/FEED_ID" \
-H "X-API-Key: YOUR_PROJECT_API_KEY"

API Key Rotation & Security

Create a new key with the same permissions

Deploy the new key to all applications and services gradually

Verify old key usage drops to zero before proceeding

Disable the previous key once migration is complete

Update internal documentation and notify team members

Rotate keys every 90–365 days for stronger security.

Next Steps

Authentication Methods

Learn about different API authentication approaches and best practices

API Endpoints

Explore the complete API reference with examples and response formats

Security Best Practices

Comprehensive security guidelines for API integration