API v1 reference
The public endpoints, their methods, authentication, pagination, errors and rate limits.
Base URL: https://app.outercite.com/api/v1. Authenticate with a bearer token. Every response is JSON.
What you'll learn
- How to authenticate and what a response looks like
- The endpoints, with their methods
- Errors, pagination and rate limits
Authentication
curl -H "Authorization: Bearer $OUTERCITE_API_KEY" \
https://app.outercite.com/api/v1/dashboard/statsKeys are created in API settings and carry explicit permissions. A new key is read-only by default. See API access for the permission list.
Endpoints
Position and evidence
| Endpoint | Methods |
|---|---|
/dashboard/stats | GET |
/dashboard/intelligence | GET |
/platforms/coverage | GET |
/citations | GET |
/citations/{id} | GET |
/briefs/latest | GET |
Prompts
| Endpoint | Methods |
|---|---|
/keywords | GET, POST |
/keywords/{id} | GET, DELETE |
/keywords/{id}/citations | GET |
/keywords/{id}/trends | GET |
The path says keywords and the product says prompts. They are the same object; the path is kept stable so existing
integrations keep working.
Competitors
| Endpoint | Methods |
|---|---|
/competitors | GET, POST |
/competitors/{id} | GET, DELETE |
/competitors/landscape | GET |
The loop
| Endpoint | Methods |
|---|---|
/actions | GET |
/actions/{id} | PATCH |
/recommendations | GET |
/recommendations/{id} | PATCH |
/insights | GET |
/insights/{id}/promote | POST |
/audits/trigger | POST |
Forecasts
| Endpoint | Methods |
|---|---|
/predictions | GET, POST |
/predictions/{id} | GET |
Shopping
| Endpoint | Methods |
|---|---|
/products | GET, POST |
/products/{id} | GET, PATCH, DELETE |
Trace
| Endpoint | Methods |
|---|---|
/citetrace/visits | GET |
The ingest endpoints under /citetrace are used by the tag and the edge worker, not by your integration.
Keys and webhooks
| Endpoint | Methods |
|---|---|
/api-keys | GET, POST |
/api-keys/{id} | DELETE |
/webhooks | GET, POST |
/webhooks/{id} | DELETE |
/webhooks/{id}/test | POST |
Common parameters
- Pagination. List endpoints accept
limitandoffset, and return the total alongside the rows. - Filtering citations.
platform,cited,tieranddateRangein days. - Agency scope. A key with the cross-workspace permission can scope a request to one client workspace.
Platform ids
chatgpt, claude, google_ai, google_aio, perplexity, grok, deepseek.
google_ai is Gemini. google_aio is AI Overviews. They are different surfaces, and an unrecognised id is rejected with
the valid list rather than being quietly ignored.
Errors
Errors return a code and a message. The ones you will meet:
| Status | Meaning |
|---|---|
| 400 | Validation error. The message names the field and, where relevant, the valid values |
| 401 | Missing or malformed Authorization header |
| 403 | The key lacks the permission, or a plan limit blocks the action |
| 404 | No such resource in this workspace |
| 429 | Rate limited. The reset time is in the message and the limit headers |
Rate limits
Your limit comes from your plan and is reported on the response headers, so a client can back off rather than guess. Use webhooks for event-shaped work instead of polling.
Try this in Outercite
Call GET /platforms/coverage with a read-only key. It confirms authentication, your covered surfaces and your rate
limit headers in one request.
Related
API access
Keys, permissions and conventions.
Webhooks
Events, signatures and retries.
Data definitions
What the fields mean.
Last updated on