Documentation Index
Fetch the complete documentation index at: https://usenaive.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
AEO (Answer Engine Optimization) gives your agent tools to understand and optimize for AI search. Track how LLMs like ChatGPT, Claude, Gemini, and Perplexity respond to queries, monitor brand mentions in AI responses, scrape ChatGPT Search results with citations, and analyze AI search volume trends.
CLI First
# LLM response check
naive aeo llm-responses chatgpt --keyword "best project management software 2026"
# LLM mentions tracking
naive aeo llm-mentions search --keyword "project management software" --domain example.com
# AI keyword volume
naive aeo ai-keywords --keywords "project management software"
Endpoints
| API | Endpoint | Description | Speed | Cost |
|---|
| LLM Responses | POST /v1/aeo/llm-responses/:platform | Get responses from ChatGPT, Claude, Gemini, Perplexity | Live (~5-15s) | 3 credits |
| LLM Responses | POST /v1/aeo/llm-responses/:platform/task | Async task submission (chatgpt, claude, gemini only) | Standard | 3 credits |
| LLM Responses | GET /v1/aeo/llm-responses/:platform/task/:id | Retrieve async task results | GET | Free |
| LLM Responses | GET /v1/aeo/llm-responses/:platform/tasks-ready | Check for completed tasks | GET | Free |
| LLM Responses | GET /v1/aeo/llm-responses/:platform/models | List available models for a platform | GET | Free |
| LLM Scraper | POST /v1/aeo/llm-scraper/chatgpt | Scrape ChatGPT Search (advanced format) | Live | 3 credits |
| LLM Scraper | POST /v1/aeo/llm-scraper/chatgpt/html | Scrape ChatGPT Search (HTML format) | Live | 3 credits |
| LLM Scraper | POST /v1/aeo/llm-scraper/chatgpt/task | Async scraper task submission | Standard | 3 credits |
| LLM Scraper | GET /v1/aeo/llm-scraper/chatgpt/task/:id | Retrieve scraper results (advanced) | GET | Free |
| LLM Scraper | GET /v1/aeo/llm-scraper/chatgpt/task/:id/html | Retrieve scraper results (HTML) | GET | Free |
| LLM Scraper | GET /v1/aeo/llm-scraper/chatgpt/tasks-ready | Check for completed scraper tasks | GET | Free |
| AI Keywords | POST /v1/aeo/ai-keywords/search-volume | AI search volume estimates | Live | 2 credits |
| LLM Mentions | POST /v1/aeo/llm-mentions/search | Detailed mentions with counts and cited links | Live | 2 credits |
| LLM Mentions | POST /v1/aeo/llm-mentions/aggregated-metrics | Consolidated metrics across dimensions | Live | 2 credits |
| LLM Mentions | POST /v1/aeo/llm-mentions/cross-aggregated-metrics | Compare metrics across multiple targets | Live | 2 credits |
| LLM Mentions | POST /v1/aeo/llm-mentions/top-domains | Most frequently mentioned domains | Live | 2 credits |
| LLM Mentions | POST /v1/aeo/llm-mentions/top-pages | Top mentioned pages for a keyword | Live | 2 credits |
| General | POST /v1/aeo/id-list | List task IDs across all sub-APIs | POST | Free |
LLM Responses
Get responses from major AI models to see what they say about your brand, product, or topic.
| LLM | Live Endpoint | Standard (async) | Models |
|---|
| ChatGPT | POST /v1/aeo/llm-responses/chatgpt | task, task/:id, tasks-ready | GET .../chatgpt/models |
| Claude | POST /v1/aeo/llm-responses/claude | task, task/:id, tasks-ready | GET .../claude/models |
| Gemini | POST /v1/aeo/llm-responses/gemini | task, task/:id, tasks-ready | GET .../gemini/models |
| Perplexity | POST /v1/aeo/llm-responses/perplexity | Live only — no async | GET .../perplexity/models |
# Get ChatGPT's response to a query (live)
curl -X POST https://api.usenaive.ai/v1/aeo/llm-responses/chatgpt \
-H "Authorization: Bearer nv_sk_your_key" \
-H "Content-Type: application/json" \
-d '{ "user_prompt": "best project management software 2026", "model_name": "gpt-4o-mini" }'
Response:
{
"results": [
{
"keyword": "best project management software 2026",
"model": "gpt-4o",
"response": "Here are some of the best project management tools in 2026:\n\n1. **Asana** — Great for team collaboration...\n2. **Linear** — Developer-focused with fast UI...\n3. **Notion** — All-in-one workspace...",
"cited_domains": ["asana.com", "linear.app", "notion.so"],
"cited_urls": [
"https://asana.com/product",
"https://linear.app/features"
]
}
],
"credits_used": 3
}
Parameters
| Param | Type | Required | Default | Description |
|---|
user_prompt | string | Yes | — | Query to send to the LLM |
model_name | string | Yes | — | Model to use (e.g. “gpt-4o-mini”) |
location_code | number | No | — | Location code |
language_code | string | No | — | Language code |
The CLI maps --keyword to user_prompt and defaults model_name to gpt-4o-mini if --model is not specified.
When to use
- Monitoring what LLMs say about your brand or product
- Comparing how different AI models describe a topic
- Identifying which competitors get mentioned in AI responses
- Auditing AI search visibility across platforms
LLM Scraper
Scrape ChatGPT Search results including citations, source links, and structured response data. Two output formats: advanced (structured JSON) and HTML (raw rendered output).
| Endpoint | Description | Method |
|---|
POST /v1/aeo/llm-scraper/chatgpt | Scrape ChatGPT Search (advanced format) | Live |
POST /v1/aeo/llm-scraper/chatgpt/html | Scrape ChatGPT Search (HTML format) | Live |
POST /v1/aeo/llm-scraper/chatgpt/task | Submit async scraping task | Standard |
GET /v1/aeo/llm-scraper/chatgpt/task/:id | Get results (advanced format) | GET |
GET /v1/aeo/llm-scraper/chatgpt/task/:id/html | Get results (HTML format) | GET |
GET /v1/aeo/llm-scraper/chatgpt/tasks-ready | Check for completed tasks | GET |
Parameters
| Param | Type | Required | Default | Description |
|---|
keyword | string | Yes | — | Query to send to ChatGPT Search |
location_code | number | No | — | Location code |
language_code | string | No | — | Language code |
When to use
- Getting full ChatGPT Search results with source citations
- Analyzing which sources ChatGPT cites for your keywords
- Comparing live ChatGPT output vs. LLM Responses API data
AI Keyword Data
Get search volume estimates for keywords in AI search engines.
curl -X POST https://api.usenaive.ai/v1/aeo/ai-keywords/search-volume \
-H "Authorization: Bearer nv_sk_your_key" \
-H "Content-Type: application/json" \
-d '{ "keywords": ["best ai tools", "chatbot for business", "ai agent framework"] }'
Response:
{
"results": [
{ "keyword": "best ai tools", "ai_search_volume": 48200, "competition": "medium" },
{ "keyword": "chatbot for business", "ai_search_volume": 22100, "competition": "high" },
{ "keyword": "ai agent framework", "ai_search_volume": 8400, "competition": "low" }
],
"credits_used": 2
}
Parameters
| Param | Type | Required | Default | Description |
|---|
keywords | string[] | Yes | — | Keywords to check (up to 1000) |
location_code | number | No | — | Location code |
When to use
- Estimating AI search demand before creating content
- Comparing traditional vs. AI search volume
- Prioritizing keywords for AEO optimization
LLM Mentions
Track how often brands, domains, and keywords appear in LLM responses. All endpoints use Live method.
| Endpoint | Description |
|---|
search | Detailed mentions data with counts and cited links |
aggregated-metrics | Consolidated metrics across dimensions |
cross-aggregated-metrics | Compare metrics across multiple targets |
top-domains | Most frequently mentioned domains for a keyword |
top-pages | Top mentioned pages for a keyword |
# Track brand mentions in LLM responses
curl -X POST https://api.usenaive.ai/v1/aeo/llm-mentions/search \
-H "Authorization: Bearer nv_sk_your_key" \
-H "Content-Type: application/json" \
-d '{ "domain": "salesforce.com", "target": [{"domain": "salesforce.com"}] }'
Response:
{
"results": [
{
"keyword": "CRM software",
"target": "salesforce.com",
"mention_count": 47,
"llm_platforms": ["chatgpt", "claude", "gemini", "perplexity"],
"cited_urls": [
"https://salesforce.com/products/crm",
"https://salesforce.com/solutions/small-business"
],
"context_snippets": [
"Salesforce remains one of the most widely used CRM platforms..."
]
}
],
"credits_used": 2
}
Parameters
| Param | Type | Required | Default | Description |
|---|
keyword | string | — | — | keyword OR domain (exactly one required) |
domain | string | — | — | keyword OR domain (exactly one required) |
target | object[] | Yes | — | Targets to track, array of objects with domain key |
location_code | number | No | — | Location code |
date_from | string | No | — | Start date (YYYY-MM-DD) |
date_to | string | No | — | End date (YYYY-MM-DD) |
When to use
- Monitoring your brand’s presence in AI-generated answers
- Benchmarking competitor visibility across LLMs
- Identifying which domains dominate AI search for your keywords
- Tracking mention trends over time
Error Handling
| Error | Cause | Recovery |
|---|
insufficient_credits | Not enough credits | Check balance with GET /v1/status |
invalid_llm | Unknown LLM platform name | Use chatgpt, claude, gemini, or perplexity |
invalid_keywords | Empty or malformed keyword list | Provide at least one keyword string |
invalid_input | Platform doesn’t support async tasks | Perplexity is live-only; use chatgpt, claude, or gemini for tasks |
provider_error | Data provider returned an error | Retry after a few seconds |
Perplexity only supports the Live method — no async task endpoints. For batch processing across multiple LLMs, submit async tasks for ChatGPT, Claude, and Gemini, then use live calls for Perplexity.
Typical Workflow
Agent receives task: "Audit our brand visibility in AI search"
│
├─ POST /v1/aeo/llm-responses/chatgpt → Check ChatGPT's response
│ { keyword: "best [product category]" }
│ → Full response with brand mentions, cited domains
│
├─ POST /v1/aeo/llm-responses/claude → Check Claude's response
│ { keyword: "best [product category]" }
│ → Compare across models
│
├─ POST /v1/aeo/llm-mentions/search → Track mention frequency
│ { keyword: "product category", target: "yourbrand.com" }
│ → Mention count, cited URLs, context snippets
│
├─ POST /v1/aeo/llm-mentions/top-domains → See who dominates
│ { keyword: "product category" }
│ → Ranked list of most-mentioned domains
│
└─ POST /v1/aeo/ai-keywords/search-volume → Estimate AI search demand
{ keywords: ["product category", "brand name"] }
→ Volume estimates for AI search
Credit Costs
| Operation | Credits |
|---|
| LLM Responses live | 3 |
| LLM Responses task_post | 3 |
| LLM Scraper live | 3 |
| LLM Scraper task_post | 3 |
| AI Keywords live | 2 |
| LLM Mentions live | 2 |
| Models GET | Free |
| Task retrieval (task/:id, tasks-ready) | Free |
| id-list | Free |