Access to The Swarm API is secured using an API key mechanism, ensuring only authorized users can interact with the endpoints. Each API key is tied to a specific Team within The Swarm, so you must be an owner or admin of a Team and on the appropriate plan to use it.
Include your API key in the headers of each request by adding it as the x-api-key header. This authenticates your API calls and allows access to Team-specific data, such as profiles, lists, and tags.
Your API key is a powerful credential—treat it like a password:
Keep it private: Never share your API key in public spaces, such as GitHub or client-side code.
Protect your access: Unauthorized use of your API key can compromise your data and system integrity.
Start small: When using the API, we suggest testing with a small batch of inputs first. This allows you to validate your setup and ensure everything works smoothly before scaling your processes.
Rate Limits: Be mindful of rate limits to avoid unnecessary throttling (learn more here).
With your API key in hand, you’re ready to securely access The Swarm API and its capabilities!