Authentication

API Key Authentication

The SeaLegs API uses API keys to authenticate requests. You can create and manage API keys from your dashboard.

Include your API key in the Authorization header of every request:

Authorization: Bearer sk_live_your_api_key_here

API Key Format

API keys follow this format:

sk_live_xxxxxxxxxxxxxxxx   # Production key
sk_test_xxxxxxxxxxxxxxxx   # Test/sandbox key (coming soon)

Creating API Keys

To create a new API key:

1. Log in to your developer dashboard
2. Navigate to "API Keys"
3. Click "Create New Key"
4. Enter a descriptive name for your key
5. Copy and securely store the key

Example Requests

# Using the Authorization header (recommended)
curl https://api.sealegs.ai/v3/spotcast/spc_abc123 \
  -H "Authorization: Bearer sk_live_your_api_key"

import requests
import os

# Store API key in environment variable
API_KEY = os.environ.get("SEALEGS_API_KEY")

response = requests.get(
    "https://api.sealegs.ai/v3/spotcast/spc_abc123",
    headers={
        "Authorization": f"Bearer {API_KEY}"
    }
)

print(response.json())

// Store API key in environment variable
const API_KEY = process.env.SEALEGS_API_KEY;

const response = await fetch(
  'https://api.sealegs.ai/v3/spotcast/spc_abc123',
  {
    headers: {
      'Authorization': `Bearer ${API_KEY}`
    }
  }
);

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

Authentication Errors

If authentication fails, you'll receive one of these errors:

Example error response:

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key provided is invalid or has been revoked."
  }
}

Key Management

Revoking Keys

If you believe a key has been compromised, revoke it immediately from your dashboard. Revoked keys will stop working instantly.

Multiple Keys

You can create multiple API keys for different purposes:

• Separate keys for development and production
• Different keys for different applications
• Keys for different team members

Key Rotation

We recommend rotating your API keys periodically:

1. Create a new API key
2. Update your application to use the new key
3. Verify the new key works correctly
4. Revoke the old key

Security Best Practices