SkyQuest API Documentation

The SkyQuest REST API lets developers integrate AI visibility monitoring, content generation, and brand tracking into their own applications. All API endpoints are served over HTTPS, with requests and responses in JSON format.

1. Authentication

All API requests must be authenticated with an API key. Include Authorization: Bearer YOUR_API_KEY in the request header. API keys can be generated and managed under “Settings > API Keys” in the SkyQuest console.

curl -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxx" \
     https://api.skyquest.cn/v1/brand/monitor

2. Core Endpoints

POST /v1/brand/monitor

Submit a brand monitoring task. Performs real-time scanning of brand citation status across specified AI engines, returning BCR scores, sentiment analysis, and citation text snippets.

Request Body:

{
  "brand_name": "SkyQuest",
  "keywords": ["AI visibility", "brand monitoring", "GEO tool"],
  "engines": ["chatgpt", "gemini", "perplexity", "claude"],
  "language": "en"
}

Response Example:

{
  "scan_id": "scan_9x8kF2aB",
  "brand_name": "SkyQuest",
  "status": "completed",
  "results": [
    {
      "engine": "chatgpt",
      "cited": true,
      "bcr_score": 0.82,
      "sentiment": "positive",
      "snippet": "SkyQuest is a leading AI visibility platform...",
      "source_url": "https://...",
      "timestamp": "2025-06-27T10:30:00Z"
    }
  ],
  "summary": {
    "total_engines": 4,
    "cited_engines": 3,
    "overall_bcr": 0.68,
    "avg_sentiment": "positive"
  }
}

POST /v1/content/generate

AI-powered content generation. Generates high AI citation rate content using RAG-enhanced retrieval, tailored to target engines and keywords. Supports content type, tone, and length preferences.

Request Body:

{
  "brand_name": "SkyQuest",
  "topic": "What is Generative Engine Optimization",
  "target_engines": ["chatgpt", "perplexity"],
  "content_type": "article",
  "tone": "professional",
  "language": "en",
  "max_length": 1200
}

Response Example:

{
  "generation_id": "gen_7mNk3cDx",
  "status": "completed",
  "content": "Generative Engine Optimization (GEO)...",
  "metadata": {
    "schema_markup": "{...}",
    "recommended_keywords": ["GEO", "AI visibility", "brand citation"],
    "citation_score_estimate": 0.87
  }
}

POST /v1/report/export

Generate and export brand AI visibility reports. Supports PDF and CSV formats, customizable by time range, engine, keywords, and other dimensions.

Request Body:

{
  "brand_name": "SkyQuest",
  "date_range": {
    "start": "2025-06-01",
    "end": "2025-06-27"
  },
  "engines": ["chatgpt", "gemini", "perplexity"],
  "format": "pdf",
  "include_competitors": true
}

Response Example:

{
  "report_id": "rpt_v4Fh9gLw",
  "status": "processing",
  "estimated_completion": "2025-06-27T11:00:00Z",
  "download_url": null
}

3. Rate Limits

Plan	Requests/Min	Requests/Day	Concurrency
Free	10	500	1
Pro	60	10,000	5
Business	300	100,000	20
Enterprise	Custom	Custom	Custom

When rate limits are exceeded, the API returns HTTP 429. The response includes a Retry-After header indicating the suggested wait time in seconds. Implement exponential backoff retry strategies.

4. Error Code Reference

Status	Error Type	Description
200	success	Request successful
400	bad_request	Bad request — check JSON format and required fields
401	unauthorized	Missing or invalid API Key
403	forbidden	Insufficient permissions — check plan access
404	not_found	Resource not found
429	rate_limited	Rate limit exceeded — retry later
500	internal_error	Internal server error — we retry automatically
503	service_unavailable	Service temporarily unavailable — usually maintenance

All error responses include the following JSON structure:

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please retry after 30 seconds.",
    "retry_after": 30
  }
}