ReddGrowReddGrow Docs
API v1Reference

Aeo

Answer Engine Optimization — prompts, runs, visibility, sources, brands, topics

Return API key metadata and usage for the authenticated org

GET
/v1/aeo/me

Authorization

x-api-key<token>

In: header

curl -X GET "https://api.reddgrow.ai/v1/aeo/me" \
  -H "x-api-key: <token>"

Account info returned

List all supported AI engines

GET
/v1/aeo/engines

Authorization

x-api-key<token>

In: header

curl -X GET "https://api.reddgrow.ai/v1/aeo/engines" \
  -H "x-api-key: <token>"

Engine list returned

List all supported country codes and names

GET
/v1/aeo/countries

Authorization

x-api-key<token>

In: header

curl -X GET "https://api.reddgrow.ai/v1/aeo/countries" \
  -H "x-api-key: <token>"

Country list returned

Return the scoring methodology documentation

GET
/v1/aeo/score-methodology

Authorization

x-api-key<token>

In: header

curl -X GET "https://api.reddgrow.ai/v1/aeo/score-methodology" \
  -H "x-api-key: <token>"

Score methodology returned

List all prompts with aggregated visibility stats

GET
/v1/aeo/prompts

Authorization

x-api-key<token>

In: header

Query Parameters

topic_idnumber
countrystring
enginestring
tostring
fromstring
brand_idnumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/prompts?country=string&engine=string&to=string&from=string" \
  -H "x-api-key: <token>"

Prompts list returned

Create a new tracked prompt

POST
/v1/aeo/prompts

Authorization

x-api-key<token>

In: header

curl -X POST "https://api.reddgrow.ai/v1/aeo/prompts" \
  -H "x-api-key: <token>"

Prompt created

Get a single prompt by ID with stats

GET
/v1/aeo/prompts/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

idRequirednumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/prompts/{id}" \
  -H "x-api-key: <token>"

Prompt returned

Update a tracked prompt

PATCH
/v1/aeo/prompts/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

idRequirednumber
curl -X PATCH "https://api.reddgrow.ai/v1/aeo/prompts/{id}" \
  -H "x-api-key: <token>"

Prompt updated

Delete a tracked prompt

DELETE
/v1/aeo/prompts/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

idRequirednumber
curl -X DELETE "https://api.reddgrow.ai/v1/aeo/prompts/{id}" \
  -H "x-api-key: <token>"

Prompt deleted

List scan runs for a specific prompt

GET
/v1/aeo/prompts/{id}/runs

Authorization

x-api-key<token>

In: header

Path Parameters

idRequirednumber

Query Parameters

offsetnumber
limitnumber
tostring
fromstring
countrystring
enginestring
curl -X GET "https://api.reddgrow.ai/v1/aeo/prompts/{id}/runs?to=string&from=string&country=string&engine=string" \
  -H "x-api-key: <token>"

Prompt runs returned

Create multiple tracked prompts in a single request (async)

POST
/v1/aeo/prompts/batch

Authorization

x-api-key<token>

In: header

curl -X POST "https://api.reddgrow.ai/v1/aeo/prompts/batch" \
  -H "x-api-key: <token>"

Prompts batch job queued

Get the status of a bulk prompts creation job

GET
/v1/aeo/prompts/batch/{jobId}

Authorization

x-api-key<token>

In: header

Path Parameters

jobIdRequiredstring
curl -X GET "https://api.reddgrow.ai/v1/aeo/prompts/batch/string" \
  -H "x-api-key: <token>"

Job status returned

Get the full answer for a specific scan run

GET
/v1/aeo/runs/{scan_result_id}

Authorization

x-api-key<token>

In: header

Path Parameters

scan_result_idRequirednumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/runs/{scan_result_id}" \
  -H "x-api-key: <token>"

Scan answer returned

Get detailed scoring explanation for a specific scan run

GET
/v1/aeo/runs/{scan_result_id}/explain

Authorization

x-api-key<token>

In: header

Path Parameters

scan_result_idRequirednumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/runs/{scan_result_id}/explain" \
  -H "x-api-key: <token>"

Explanation returned

Get AI visibility scores broken down by brand

GET
/v1/aeo/visibility/by-brand

Authorization

x-api-key<token>

In: header

Query Parameters

topic_idnumber
countrystring
enginestring
tostring
fromstring
brand_idnumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/visibility/by-brand?country=string&engine=string&to=string&from=string" \
  -H "x-api-key: <token>"

Visibility by brand returned

Get AI visibility scores broken down by country

GET
/v1/aeo/visibility/by-country

Authorization

x-api-key<token>

In: header

Query Parameters

topic_idnumber
countrystring
enginestring
tostring
fromstring
brand_idnumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/visibility/by-country?country=string&engine=string&to=string&from=string" \
  -H "x-api-key: <token>"

Visibility by country returned

Get AI visibility scores broken down by AI engine

GET
/v1/aeo/visibility/by-engine

Authorization

x-api-key<token>

In: header

Query Parameters

topic_idnumber
countrystring
enginestring
tostring
fromstring
brand_idnumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/visibility/by-engine?country=string&engine=string&to=string&from=string" \
  -H "x-api-key: <token>"

Visibility by engine returned

Get AI visibility scores broken down by topic

GET
/v1/aeo/visibility/by-topic

Authorization

x-api-key<token>

In: header

Query Parameters

countrystring
enginestring
tostring
fromstring
brand_idnumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/visibility/by-topic?country=string&engine=string&to=string&from=string" \
  -H "x-api-key: <token>"

Visibility by topic returned

Get visibility score timeline over a date range

GET
/v1/aeo/visibility/timeline

Authorization

x-api-key<token>

In: header

Query Parameters

daysnumber
countrystring
brand_idnumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/visibility/timeline?country=string" \
  -H "x-api-key: <token>"

Timeline returned

Get detailed visibility score explanation for a brand

GET
/v1/aeo/visibility/explain

Authorization

x-api-key<token>

In: header

Query Parameters

topic_idnumber
countrystring
enginestring
tostring
fromstring
brand_idRequirednumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/visibility/explain?country=string&engine=string&to=string&from=string" \
  -H "x-api-key: <token>"

Visibility explanation returned

List all brands tracked by the organization

GET
/v1/aeo/brands

Authorization

x-api-key<token>

In: header

curl -X GET "https://api.reddgrow.ai/v1/aeo/brands" \
  -H "x-api-key: <token>"

Brands list returned

Create a new brand to track

POST
/v1/aeo/brands

Authorization

x-api-key<token>

In: header

curl -X POST "https://api.reddgrow.ai/v1/aeo/brands" \
  -H "x-api-key: <token>"

Brand created

Get brand ranking by AI visibility score

GET
/v1/aeo/brands/ranking

Authorization

x-api-key<token>

In: header

Query Parameters

topic_idnumber
countrystring
enginestring
tostring
fromstring
brand_idnumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/brands/ranking?country=string&engine=string&to=string&from=string" \
  -H "x-api-key: <token>"

Brand ranking returned

Update a tracked brand

PATCH
/v1/aeo/brands/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

idRequirednumber
curl -X PATCH "https://api.reddgrow.ai/v1/aeo/brands/{id}" \
  -H "x-api-key: <token>"

Brand updated

Delete a tracked brand

DELETE
/v1/aeo/brands/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

idRequirednumber
curl -X DELETE "https://api.reddgrow.ai/v1/aeo/brands/{id}" \
  -H "x-api-key: <token>"

Brand deleted

List all topics for the organization

GET
/v1/aeo/topics

Authorization

x-api-key<token>

In: header

Query Parameters

brand_idnumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/topics" \
  -H "x-api-key: <token>"

Topics list returned

Create a new topic

POST
/v1/aeo/topics

Authorization

x-api-key<token>

In: header

curl -X POST "https://api.reddgrow.ai/v1/aeo/topics" \
  -H "x-api-key: <token>"

Topic created

Create multiple topics in a single request

POST
/v1/aeo/topics/batch

Authorization

x-api-key<token>

In: header

curl -X POST "https://api.reddgrow.ai/v1/aeo/topics/batch" \
  -H "x-api-key: <token>"

Topics created

Update a topic

PATCH
/v1/aeo/topics/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

idRequirednumber
curl -X PATCH "https://api.reddgrow.ai/v1/aeo/topics/{id}" \
  -H "x-api-key: <token>"

Topic updated

Delete a topic

DELETE
/v1/aeo/topics/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

idRequirednumber
curl -X DELETE "https://api.reddgrow.ai/v1/aeo/topics/{id}" \
  -H "x-api-key: <token>"

Topic deleted

List source domains with citation counts

GET
/v1/aeo/sources/domains

Authorization

x-api-key<token>

In: header

Query Parameters

offsetnumber
limitnumber
domain_typestring
countrystring
enginestring
tostring
fromstring
brand_idnumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/sources/domains?domain_type=string&country=string&engine=string&to=string&from=string" \
  -H "x-api-key: <token>"

Source domains returned

List source URLs with citation counts

GET
/v1/aeo/sources/urls

Authorization

x-api-key<token>

In: header

Query Parameters

offsetnumber
limitnumber
domain_typestring
tostring
fromstring
countrystring
enginestring
curl -X GET "https://api.reddgrow.ai/v1/aeo/sources/urls?domain_type=string&to=string&from=string&country=string&engine=string" \
  -H "x-api-key: <token>"

Source URLs returned

Get the top cited source domains

GET
/v1/aeo/sources/top-domains

Authorization

x-api-key<token>

In: header

Query Parameters

limitnumber
countrystring
enginestring
tostring
fromstring
brand_idnumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/sources/top-domains?country=string&engine=string&to=string&from=string" \
  -H "x-api-key: <token>"

Top domains returned

Get distribution of citation domain types

GET
/v1/aeo/sources/domain-types

Authorization

x-api-key<token>

In: header

Query Parameters

countrystring
enginestring
tostring
fromstring
brand_idnumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/sources/domain-types?country=string&engine=string&to=string&from=string" \
  -H "x-api-key: <token>"

Domain type distribution returned

Drill down into a specific source domain, URL, or query

GET
/v1/aeo/sources/detail

Authorization

x-api-key<token>

In: header

Query Parameters

page_sizenumber
pagenumber
searchstring
path_prefixstring
group_bystring
tostring
fromstring
query_idnumber
countrystring
enginestring
targetRequiredstring
scopeRequiredstring
Value in: "domain" | "url" | "query"
curl -X GET "https://api.reddgrow.ai/v1/aeo/sources/detail?search=string&path_prefix=string&group_by=string&to=string&from=string&country=string&engine=string&target=string&scope=domain" \
  -H "x-api-key: <token>"

Source detail returned

List all citations with filtering and pagination

GET
/v1/aeo/citations

Authorization

x-api-key<token>

In: header

Query Parameters

offsetnumber
limitnumber
query_idnumber
domain_typestring
domainstring
countrystring
enginestring
tostring
fromstring
brand_idnumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/citations?domain_type=string&domain=string&country=string&engine=string&to=string&from=string" \
  -H "x-api-key: <token>"

Citations returned

Get detailed sentiment explanation for a brand

GET
/v1/aeo/sentiment/explain

Authorization

x-api-key<token>

In: header

Query Parameters

topic_idnumber
countrystring
enginestring
tostring
fromstring
brand_idRequirednumber
curl -X GET "https://api.reddgrow.ai/v1/aeo/sentiment/explain?country=string&engine=string&to=string&from=string" \
  -H "x-api-key: <token>"

Sentiment explanation returned