Authentication

Pass your API key in the X-API-Key header on every request.

curl -H "X-API-Key: YOUR_API_KEY" https://opensdk.ca/api/dispatch/tasks

Getting your API key

Dashboard

1. Sign up or log in at opensdk.ca
2. Go to Dashboard > API Keys
3. Click Create API Key
4. Copy the key immediately — it's only shown once

Key limits

• One active key per account — revoke the existing key before creating a new one
• The key value is shown once at creation — store it securely
• All dispatch, export, and revise endpoints accept API key authentication

Session authentication

If you're using the OpenSDK dashboard or web UI, requests are authenticated automatically via session cookies. No API key is needed for dashboard actions.

Rate limiting

All authenticated endpoints are rate-limited to 100 requests per minute per API key. If you exceed the limit, you'll receive a 429 response with a Retry-After header.