Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.opensync.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
API Authentication

All API requests require authentication using an API key.

​
Getting an API Key

1

Sign in

Sign in to your OpenSync dashboard
2

Open Settings

Click your profile icon and select Settings
3

Generate Key

Click Generate API Key
4

Copy the key

Copy and securely store your API key. It won’t be shown again.

​
Using Your API Key

Include your API key in the Authorization header: 
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://your-deployment.convex.site/api/sessions

​
API Key Format

API keys follow the format: 
osk_[random-string]
Example: osk_7a8b9c0d1e2f3g4h5i6j7k8l9m0n

​
Security Best Practices

  • Never commit API keys to version control - Use environment variables to store keys - Rotate keys if they may be compromised - Use separate keys for different environments

​
Environment Variables

# .env file
OPENSYNC_API_KEY=osk_your_api_key_here

// In your code
const apiKey = process.env.OPENSYNC_API_KEY;

​
Rate Limits

PlanRequests/minuteRequests/day
Free601,000
Pro30010,000
Contact us if you need higher limits for your use case.

​
Revoking Keys

To revoke an API key:
  1. Go to Settings in the dashboard
  2. Find the key you want to revoke
  3. Click Revoke
Revoked keys immediately stop working.