BrandstaqBrandstaq Docs

API Keys

Programmatic access to Brandstaq via API keys.

API Keys

API keys let you access Brandstaq programmatically. Use them to create jobs, manage agents, and integrate with external tools.

Creating an API Key

  1. Go to Settings > API Keys
  2. Click Generate New Key
  3. Copy the key immediately — it's only shown once
  4. Store it securely (environment variable, secrets manager)

Scopes

Keys are scoped to specific permissions:

ScopeAccess
readRead brand kits, agents, jobs, skills
writeCreate/update brand kits, agents, jobs
adminFull access including billing, users

Usage

Include the API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.brandstaq.com/api/v1/brand-kits

Rate Limits

Rate limits vary by tier. Higher tiers get more requests per minute. See your Settings page for your current limits.

Security

  • Rotate keys regularly
  • Never commit keys to source control
  • Use environment variables in production
  • Revoke unused keys from Settings > API Keys

On this page