Skip to Content
Pindown.ai is in early alpha - features may change
Platform GuideManaging API Keys

Managing API Keys

API keys are your authentication credentials for accessing the Pindown.ai API. They allow you to automate pin creation, update datasets, and integrate with external tools.

Subscription Tiers & Limits

Different subscription tiers have different API key limits:

Starter (Free)

  • API Keys: 1 key
  • Rate Limit: 16 requests/hour
  • Scopes: All scopes available

Perfect for: Personal projects, testing, small automations

Pro

  • API Keys: 5 keys
  • Rate Limit: 1,000 requests/hour
  • Scopes: All scopes available

Perfect for: Professional workflows, multiple integrations

Teams

  • API Keys: 20 keys
  • Rate Limit: 10,000 requests/hour
  • Scopes: All scopes available

Perfect for: Teams, production systems, high-volume automation

Team

  • API Keys: 20 keys
  • Rate Limit: 5,000 requests/hour
  • Scopes: All scopes + custom scopes

Perfect for: Large teams, organizations, mission-critical systems

Creating API Keys

Via UI

Step 1: Navigate to API Keys

  1. Log in to your account
  2. Click “API Keys” in the sidebar
  3. You’ll see your existing API keys

Step 2: Create New Key

Click “Create API Key” button

Step 3: Configure Your Key

Fill in the details:

  • Name (Required): Give your key a descriptive name

    • ✅ “Production Automation”
    • ✅ “Zapier Integration”
    • ✅ “Development Testing”
    • ❌ “Key 1”

  • Scopes (Required): Permissions for this key

    • pins:read - Read pins
    • pins:write - Create and update pins
    • datasets:read - Read datasets
    • datasets:write - Create and update datasets
    • pinboards:read - Read pinboards
    • pinboards:write - Create and update pinboards

Step 4: Copy Your Key

⚠️ Important: Copy your API key immediately! You won’t be able to see it again.

pindown_sk_1234567890abcdef1234567890abcdef

Store it securely in your environment variables or password manager.

Rate Limits

Each subscription tier has different rate limits:

TierRequests/HourRequests/MinuteAPI Keys
Starter (Free)1611
Professional1,000605
Team5,00030020

Rate Limit Headers

API responses include rate limit headers:

X-RateLimit-Tier: starter
X-RateLimit-Limit: 16
X-RateLimit-Remaining: 12
X-RateLimit-Reset: 1699012800

API Key Scopes

Scopes control what actions an API key can perform. Use the minimum necessary scopes for security.

Available Scopes

Pins Scopes

  • pins:read - List and get pins
  • pins:write - Create, update, and delete pins
  • pins:share - Share pins with others

Datasets Scopes

  • datasets:read - List and get datasets
  • datasets:write - Create, update, and delete datasets

Pinboards Scopes

  • pinboards:read - List and get pinboards
  • pinboards:write - Create, update, and delete pinboards
  • pinboards:share - Share pinboards with others

Blocks Scopes

  • blocks:read - List and get blocks
  • blocks:write - Create, update, and delete blocks

Security Best Practices

1. Use Environment Variables

Never commit API keys to version control!

# .gitignore
.env
.env.local

2. Use Minimum Required Scopes

Only grant the permissions your application needs.

3. Rotate Keys Regularly

Create new keys and revoke old ones every 90 days for production systems.

4. Revoke Compromised Keys Immediately

If a key is exposed, revoke it immediately in the dashboard.

Next Steps

Sharing & CollaborationQuickstart