Skip to main content

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

APIEndpointDescriptionSpeedCost
LLM ResponsesPOST /v1/aeo/llm-responses/:platformGet responses from ChatGPT, Claude, Gemini, PerplexityLive (~5-15s)3 credits
LLM ResponsesPOST /v1/aeo/llm-responses/:platform/taskAsync task submission (chatgpt, claude, gemini only)Standard3 credits
LLM ResponsesGET /v1/aeo/llm-responses/:platform/task/:idRetrieve async task resultsGETFree
LLM ResponsesGET /v1/aeo/llm-responses/:platform/tasks-readyCheck for completed tasksGETFree
LLM ResponsesGET /v1/aeo/llm-responses/:platform/modelsList available models for a platformGETFree
LLM ScraperPOST /v1/aeo/llm-scraper/chatgptScrape ChatGPT Search (advanced format)Live3 credits
LLM ScraperPOST /v1/aeo/llm-scraper/chatgpt/htmlScrape ChatGPT Search (HTML format)Live3 credits
LLM ScraperPOST /v1/aeo/llm-scraper/chatgpt/taskAsync scraper task submissionStandard3 credits
LLM ScraperGET /v1/aeo/llm-scraper/chatgpt/task/:idRetrieve scraper results (advanced)GETFree
LLM ScraperGET /v1/aeo/llm-scraper/chatgpt/task/:id/htmlRetrieve scraper results (HTML)GETFree
LLM ScraperGET /v1/aeo/llm-scraper/chatgpt/tasks-readyCheck for completed scraper tasksGETFree
AI KeywordsPOST /v1/aeo/ai-keywords/search-volumeAI search volume estimatesLive2 credits
LLM MentionsPOST /v1/aeo/llm-mentions/searchDetailed mentions with counts and cited linksLive2 credits
LLM MentionsPOST /v1/aeo/llm-mentions/aggregated-metricsConsolidated metrics across dimensionsLive2 credits
LLM MentionsPOST /v1/aeo/llm-mentions/cross-aggregated-metricsCompare metrics across multiple targetsLive2 credits
LLM MentionsPOST /v1/aeo/llm-mentions/top-domainsMost frequently mentioned domainsLive2 credits
LLM MentionsPOST /v1/aeo/llm-mentions/top-pagesTop mentioned pages for a keywordLive2 credits
GeneralPOST /v1/aeo/id-listList task IDs across all sub-APIsPOSTFree

LLM Responses

Get responses from major AI models to see what they say about your brand, product, or topic.
LLMLive EndpointStandard (async)Models
ChatGPTPOST /v1/aeo/llm-responses/chatgpttask, task/:id, tasks-readyGET .../chatgpt/models
ClaudePOST /v1/aeo/llm-responses/claudetask, task/:id, tasks-readyGET .../claude/models
GeminiPOST /v1/aeo/llm-responses/geminitask, task/:id, tasks-readyGET .../gemini/models
PerplexityPOST /v1/aeo/llm-responses/perplexityLive only — no asyncGET .../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

ParamTypeRequiredDefaultDescription
user_promptstringYesQuery to send to the LLM
model_namestringYesModel to use (e.g. “gpt-4o-mini”)
location_codenumberNoLocation code
language_codestringNoLanguage 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).
EndpointDescriptionMethod
POST /v1/aeo/llm-scraper/chatgptScrape ChatGPT Search (advanced format)Live
POST /v1/aeo/llm-scraper/chatgpt/htmlScrape ChatGPT Search (HTML format)Live
POST /v1/aeo/llm-scraper/chatgpt/taskSubmit async scraping taskStandard
GET /v1/aeo/llm-scraper/chatgpt/task/:idGet results (advanced format)GET
GET /v1/aeo/llm-scraper/chatgpt/task/:id/htmlGet results (HTML format)GET
GET /v1/aeo/llm-scraper/chatgpt/tasks-readyCheck for completed tasksGET

Parameters

ParamTypeRequiredDefaultDescription
keywordstringYesQuery to send to ChatGPT Search
location_codenumberNoLocation code
language_codestringNoLanguage 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

ParamTypeRequiredDefaultDescription
keywordsstring[]YesKeywords to check (up to 1000)
location_codenumberNoLocation 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.
EndpointDescription
searchDetailed mentions data with counts and cited links
aggregated-metricsConsolidated metrics across dimensions
cross-aggregated-metricsCompare metrics across multiple targets
top-domainsMost frequently mentioned domains for a keyword
top-pagesTop 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

ParamTypeRequiredDefaultDescription
keywordstringkeyword OR domain (exactly one required)
domainstringkeyword OR domain (exactly one required)
targetobject[]YesTargets to track, array of objects with domain key
location_codenumberNoLocation code
date_fromstringNoStart date (YYYY-MM-DD)
date_tostringNoEnd 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

ErrorCauseRecovery
insufficient_creditsNot enough creditsCheck balance with GET /v1/status
invalid_llmUnknown LLM platform nameUse chatgpt, claude, gemini, or perplexity
invalid_keywordsEmpty or malformed keyword listProvide at least one keyword string
invalid_inputPlatform doesn’t support async tasksPerplexity is live-only; use chatgpt, claude, or gemini for tasks
provider_errorData provider returned an errorRetry 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

OperationCredits
LLM Responses live3
LLM Responses task_post3
LLM Scraper live3
LLM Scraper task_post3
AI Keywords live2
LLM Mentions live2
Models GETFree
Task retrieval (task/:id, tasks-ready)Free
id-listFree