Overview
Search Atlas supports programmatic access to Brand Voice Analysis data stored in your Brand Vault via the Search Atlas API. This is useful for integrating voice guidelines into your own tools, automating content workflows, or pulling analysis results into external platforms.
This article covers what you need to get started, including authentication, what to have ready, and how to reach our team for confirmed endpoint details specific to your account configuration.
Authentication
All Search Atlas API requests require authentication via a Bearer token. To locate or manage your API credentials, log in to Search Atlas, click your Avatar (top-right), then go to Settings → API Keys / Integrations to find your API key. If you are unable to locate your API key, our team can walk you through generating one.
What to Prepare Before Making API Requests
To successfully integrate Brand Voice Analysis data into your workflows, gather the following before you begin or before reaching out for support:
- Your API key — retrieved from your Search Atlas account Settings as described above
- Your Search Atlas account email or workspace name
- The name or ID of the Brand Vault you want to access programmatically — you can find this by opening the Brand Vault inside the platform and noting the name you assigned it
- Your intended use case — for example, pulling data into an external tool, automating a content workflow, or building a direct integration
- Any error messages or HTTP status codes you have already encountered, if applicable
- The programming language or HTTP client you are using (for example: Python, Node.js, cURL)
How API Requests Are Structured
When making requests to the Search Atlas API for Brand Voice Analysis data, follow these general steps:
- Include your API key as a Bearer token in the Authorization header of every request.
- Target the Brand Voice Analysis endpoint associated with your specific Brand Vault. Because exact endpoint paths depend on your account configuration and may be updated, confirm the current endpoint path with our team before building your integration.
- Submit a GET request (or the request method confirmed for your endpoint) and parse the JSON response, which will contain the Brand Voice Analysis fields associated with your Brand Vault.
- If you receive an HTTP error (such as 401 Unauthorized or 404 Not Found), verify that your API key is valid and that the Brand Vault name or ID in your request matches what is configured in your account.
Common Issues and How to Resolve Them
- 401 Unauthorized: Your Bearer token is missing, expired, or incorrect. Regenerate your API key in Settings and update your request headers.
- 404 Not Found: The Brand Vault identifier in your request does not match any vault in your account. Double-check the name or ID against what is shown in the platform.
- Empty or unexpected response: Confirm that Brand Voice Analysis has been run for the Brand Vault you are querying. If no analysis exists yet, run it from within the platform first, then retry your API request.
Next Steps
If you need the confirmed endpoint path, full request format, or complete response schema for your specific account, our team can provide verified technical documentation. Have your account email, Brand Vault name, use case, and any error messages ready to speed up the process.
If you need further assistance, open the chat widget in the bottom-right corner of the platform and type human teammate to be connected with a member of our team.