Use the SoWhatHQ API
Create a read-only key and retrieve your workspace intelligence programmatically.
What API access provides
The SoWhatHQ API lets an authorized internal tool retrieve intelligence that already exists in your workspace. It is designed for internal dashboards, data pipelines, workflow tools, and approved AI assistants.
API access is included with Team and Scale, and during an eligible Team trial. It is read-only: it never changes workspace data or starts new analysis.
- Competitors and monitored-source health
- Sourced insights, before-and-after evidence, recommendations, and drift alerts
- Saved battlecards and active approved messaging
- ROI outcomes, attribution evidence, and weekly digests
Create and protect a key
- 1
Open Settings → API Keys as a workspace owner or administrator.
- 2
Enter a descriptive name that identifies the system using the key.
- 3
Choose Create key.
- 4
Copy the complete key immediately and save it in the destination system’s secret manager. SoWhatHQ cannot show it again.
- 5
Revoke the key as soon as its integration is retired or the secret may have been exposed.
Make a request
Send the key in the Authorization header using the Bearer scheme. For example: curl https://sowhathq.com/api/v1/insights -H "Authorization: Bearer YOUR_API_KEY".
Available GET endpoints are /api/v1/competitors, /api/v1/insights, /api/v1/battlecards, /api/v1/messaging, /api/v1/outcomes, and /api/v1/digests. Use limit and offset query parameters for pagination; one response returns at most 100 records.
- Filter insights with competitor_id, impact, status, or an ISO-8601 since timestamp.
- Responses include pagination information and remaining rate-limit headers.
- The API returns JSON and uses standard 401, 403, 429, and 500-series status codes.
Limits and access boundaries
Each workspace can keep up to five active keys. Every key currently has the same read:workspace scope and may make up to 120 requests per minute. Revocation takes effect immediately.
Owners and administrators manage keys. Other workspace roles can see that API access exists but cannot reveal, create, or revoke credentials. Complete key secrets are never stored by SoWhatHQ; only a one-way hash and safe display prefix remain after creation.