AnswerEngine · API Reference

API Reference

REST API for AnswerEngine. Available on the Scale plan and above. Authenticate with an API key generated at /platform/dashboard/api-keys.

Authentication

Every request must include an Authorization header with a Bearer API key.

Authorization: Bearer ae_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Keys are SHA-256 hashed at rest. The plaintext is shown once at creation and never recoverable — store it in your secret manager.

Rate limits

600 requests per hour per organization across all v1 endpoints. 429 with Retry-After header on overflow.

Endpoints

GET/api/v1/sites

List all sites owned by the authenticated org with summary stats.

curl -H "Authorization: Bearer ae_xxxxx" \
  https://bacwaterdepot.com/api/v1/sites

GET/api/v1/citations?siteId=&engine=&from=&to=&limit=

List AI citation results. All query params optional. siteId and engine filter results; from/to are ISO date strings; limit max 500.

curl -H "Authorization: Bearer ae_xxxxx" \
  "https://bacwaterdepot.com/api/v1/citations?engine=perplexity&limit=50"

GET/api/v1/keywords?siteId=

List keywords. Optional siteId filter.

curl -H "Authorization: Bearer ae_xxxxx" \
  "https://bacwaterdepot.com/api/v1/keywords?siteId=42"

POST/api/v1/keywords

Add a keyword to a site. siteId + query required. intent: informational | commercial | transactional | branded.

{
  "siteId": 42,
  "query": "best CRM for startups",
  "intent": "commercial",
  "priority": 80
}

Webhooks

Subscribe to events at /platform/dashboard/webhooks. Every delivery includes X-AnswerEngine-Signature — HMAC-SHA256 of the body using your webhook secret.

citation.win

Fired the first time a tracked query gets cited by an AI engine.

scan.complete

Fired when a site scan finishes.

page.published

Fired when content-engine drafts a new page.

page.live

Fired when a customer marks a page as live (and CMS push succeeds).

reddit.draft

Fired when the Reddit answer-radar generates a new draft for review.

Verify in Node.js:

import { createHmac } from "node:crypto";

const expected = createHmac("sha256", WEBHOOK_SECRET).update(rawBody).digest("hex");
if (expected !== req.headers["x-answerengine-signature"]) {
  return res.status(401).end();
}

Get started

Generate API key →