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

1. Go to app.reddgrow.ai and navigate to Settings → API Keys
2. Click Create key and give it a descriptive name (e.g. My AEO integration)
3. Copy the key immediately — it starts with rg_ and will not be shown again

You need a Pro plan to authenticate to the AEO API. If your key returns HTTP 402, upgrade your plan first.

Step 2: Verify your key

curl -H "x-api-key: rg_YOUR_KEY" https://api.reddgrow.ai/v1/aeo/me

Expected response:

{
  "data": {
    "org_id": "org_abc123",
    "plan": "pro",
    "prompt_limit": 10,
    "prompt_usage": 0,
    "rate_limits": {
      "per_minute": 60,
      "per_hour": 1000
    },
    "key_name": "My AEO integration"
  }
}

If you see 401, your key is invalid or missing. If you see 402, your plan doesn't include API access.

Step 3: Create your first tracked prompt

First, get your brand ID:

curl -H "x-api-key: rg_YOUR_KEY" https://api.reddgrow.ai/v1/aeo/brands

Then 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