Documentation Index
Fetch the complete documentation index at: https://docs.qwairy.co/llms.txt
Use this file to discover all available pages before exploring further.
get_brand_perception
Get brand perception analysis: sentiment, alignment, consistency scores, and SWOT insights (strengths, weaknesses, opportunities, threats).
Parameters
| Parameter | Type | Required | Description |
|---|
brandId | string | Yes | The brand ID from list_brands |
Returns
| Field | Description |
|---|
snapshot.sentimentScore | Overall sentiment score |
snapshot.alignmentScore | Alignment with brand positioning |
snapshot.consistencyScore | Consistency across AI providers |
strengths[] | Brand strengths identified by AI |
weaknesses[] | Areas of improvement |
opportunities[] | Growth opportunities |
threats[] | Potential threats |
OAuth Scope
Requires: read:visibility
get_technical_status
Get technical SEO status: robots.txt, llms.txt, sitemap.xml analysis, blocked AI crawlers, and open page issues by severity.
Parameters
| Parameter | Type | Required | Description |
|---|
brandId | string | Yes | The brand ID from list_brands |
Returns
| Field | Description |
|---|
technical.robotsStatus | robots.txt analysis status |
technical.llmsStatus | llms.txt analysis status |
technical.sitemapStatus | sitemap.xml analysis status |
technical.blockedCrawlers[] | AI crawlers blocked by robots.txt |
issues | Open issues count by severity (critical, high, medium, low) |
topIssues[] | Most important open issues |
OAuth Scope
Requires: read:visibility
get_prompt_signals
Get prompt signal analysis: attack/defend/monitor/ignore labels based on Share of Voice and market openness. Identifies which prompts to invest in. Supports period, provider, topic, and tag filters.
Parameters
| Parameter | Type | Required | Description |
|---|
brandId | string | Yes | The brand ID from list_brands |
period | number | No | Number of days to analyze (e.g. 1, 7, 14, 30). Omit for all time. |
startDate | string | No | Start date in YYYY-MM-DD format |
endDate | string | No | End date in YYYY-MM-DD format |
providers | string[] | No | Filter by provider slugs (e.g. ["openai", "anthropic"]) |
topicIds | string[] | No | Filter by topic/keyword IDs |
tagIds | string[] | No | Filter by tag IDs |
limit | number | No | Max prompts per category (default: 5) |
Returns
| Field | Description |
|---|
summary.attackCount | Prompts where market is open and brand is underrepresented |
summary.defendCount | Prompts where brand has strong position to defend |
summary.monitorCount | Prompts to keep watching |
summary.ignoreCount | Low-priority prompts |
summary.avgOpenness | Average market openness (0-1) |
summary.visibilityRate | Percentage of prompts where brand is visible |
summary.avgSoV | Average Share of Voice across visible prompts |
summary.totalPrompts | Total prompts analyzed |
topAttackPrompts[] | Best attack opportunities — includes priorityScore, visibilityPct, quadrant |
topDefendPrompts[] | Positions to defend — includes priorityScore, visibilityPct, quadrant |
OAuth Scope
Requires: read:prompts
