Quickstart
Make your first API call in under 5 minutes.
Quickstart
You'll go from zero to live scan results in 5 steps. Steps 1–4 take under 5 minutes. Step 5 requires waiting for the next daily scan (up to 24 hours).
Step 1: Create an API key
- Go to app.reddgrow.ai and navigate to Settings → API Keys
- Click Create key and give it a descriptive name (e.g.
My AEO integration) - Copy the key immediately — it starts with
rg_and will not be shown again
The AEO API is open to all plans. Your plan only sets how many prompts you can track.
Step 2: Verify your key
curl -H "x-api-key: rg_YOUR_KEY" https://api.reddgrow.ai/v1/aeo/meExpected response:
{
"data": {
"org_id": "org_abc123",
"plan": "pro",
"prompt_limit": 10,
"prompt_usage": 0,
"rate_limits": {
"per_minute": 100,
"scope": "ip"
},
"key_name": "My AEO integration"
}
}If you see 401, your key is invalid or missing. 402 only appears when you add a prompt beyond your plan's tracked-prompt limit.
Step 3: Create your first tracked prompt
First, get your brand ID. If you have no brand yet, create one with POST /v1/aeo/brands; you can pass extra_domains for other sites it owns, and you do not need an advocate for AI visibility tracking (that is only used to draft Reddit replies and can be added later).
Get your brand ID:
curl -H "x-api-key: rg_YOUR_KEY" https://api.reddgrow.ai/v1/aeo/brandsThen create a prompt:
curl -X POST https://api.reddgrow.ai/v1/aeo/prompts \
-H "x-api-key: rg_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "best project management software",
"brand_id": YOUR_BRAND_ID,
"country": "US"
}'Expected response:
{
"data": {
"id": 1234,
"query": "best project management software",
"brand_id": 42,
"country": "US",
"created_at": "2026-04-10T12:00:00.000Z"
}
}Note the id — you'll use it to fetch results.
Note: Your first results appear within 24 hours, after the next daily scheduled scan runs at 03:00 UTC. This is by design — the API does not trigger on-demand scans to prevent runaway costs against your prompt quota.
Step 4: Fetch your results
After the first scan completes (check back in up to 24 hours):
curl "https://api.reddgrow.ai/v1/aeo/prompts/1234/runs?engine=chatgpt&limit=5" \
-H "x-api-key: rg_YOUR_KEY"Each run contains the full AI answer text, all extracted citations, brand mention status, sentiment label, and brand position.
Step 5: Check your visibility score
curl "https://api.reddgrow.ai/v1/aeo/visibility/by-brand?brand_id=YOUR_BRAND_ID" \
-H "x-api-key: rg_YOUR_KEY"This returns visibility_pct — the percentage of all scans where your brand was mentioned — along with average sentiment and average position.
What's next
- Core Concepts — understand the full data model before building
- API Reference — every endpoint, every parameter
- How Scores Are Computed — understand exactly what visibility_pct means