Skip to main content

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.

Build custom dashboards, integrate with your marketing stack, or create automated reports using your GEO (Generative Engine Optimization) data.
The API is available for Growth, Business, and Enterprise plans. Upgrade your plan to get access.

​
Base URL

All API endpoints are relative to: 
https://www.qwairy.co/api/v1

​
Available Endpoints

The API provides access to all your GEO monitoring data:
ResourceDescription
BrandsList all brands in your account
PerformanceGet performance snapshots (Audit FLASH format)
CompetitorsTrack competitor mentions and share of voice
Source DomainsMonitor domains cited by AI platforms
Source URLsTrack individual pages cited in AI responses
PromptsAccess your monitored prompts/queries
AnswersRetrieve AI-generated responses
SearchDiscover web queries AI models trigger before responding

​
Quick Start

1

Get your API token

Go to Team Settings → Integrations → API Access and create a new API token.
2

Make your first request

curl -X GET "https://www.qwairy.co/api/v1/brands" \
  -H "Authorization: Bearer qw-api-your-token-here"
3

Explore your data

Use the brand ID to access performance metrics, competitors, sources, and more.

​
Response Format

All responses are JSON formatted with a consistent structure: 
{
  "success": true,
  "pagination": {
    "total": 156,
    "count": 10,
    "limit": 10,
    "offset": 0
  },
  "prompts": [ ... ]
}
List endpoints include a pagination object with:
  • total: Total items matching the query
  • count: Items in this response
  • limit: Max items per page
  • offset: Items skipped
See Entities for detailed data structures. Error responses include machine-readable codes: 
{
  "error": {
    "code": "BRAND_NOT_FOUND",
    "message": "Brand not found or not accessible"
  }
}
See Error Codes for the complete list.

​
Need Help?