Overview
Competiflow monitors competitor websites and turns page changes into an interpreted feed you can act on. Each change includes severity, a plain-language summary, recommended action, and a verifiable evidence chain (before/after field diffs).
Use the REST API to create workspaces, add competitors, read changes, and pull workspace digests. For AI agents, use the MCP server.
Base URL
https://api.competiflow.com/v1
Path-based access is also available at https://competiflow.com/api/v1/ for development.
Authentication
All requests require an API key:
Authorization: Bearer sk_live_...
Create keys in the dashboard under Settings → API keys. See Authentication for details.
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /workspaces |
List workspaces |
| POST | /workspaces |
Create a workspace |
| GET | /workspaces/:id |
Get workspace details |
| GET | /workspaces/:id/digest |
Workspace digest (overview) |
| GET | /workspaces/:id/competitors |
List competitors in a workspace |
| POST | /workspaces/:id/competitors |
Add a competitor (async discovery) |
| GET | /competitors/:id |
Get competitor details |
| GET | /competitors/:id/discovery_status |
Poll discovery progress |
| GET | /monitors |
List monitors (?workspace_id= required) |
| GET | /monitors/:id |
Get monitor details |
| POST | /monitors/:id/check |
Trigger an on-demand check |
| GET | /changes |
List changes (?workspace_id= required) |
| GET | /changes/:id |
Get change detail with evidence |
Response format
Successful responses return JSON objects. Errors use a consistent shape:
{
"error": {
"code": "not_found",
"message": "Record not found"
}
}
See Errors for the full reference.
Resources
- Quickstart — first API call in under a minute
- OpenAPI spec
- Postman collection
- Billing — how checks and plan limits work