API v1.1 ยท Stable Edition

One Line of Code, Full GEO Power

AI Search Simulator, GEO Health Check, AI Visibility Analysis โ€” no need to build your own models, just call and use. GEO infrastructure built for developers and enterprises.

๐Ÿš€ Quick Start ๐Ÿ’ฐ View Pricing
6+
API Endpoints
5
AI Platform Coverage
99.5%
Service Availability
<3s
Avg. Response

What Can You Get from the API?

No need to build models or write algorithms โ€” one line of code gives you Pro GEO analysis results. Below is the data each endpoint returns:

๐Ÿ”ฅ AI Search Simulator

Will 5 AI Platforms Recommend You?

Enter brand + industry, and the system simulates ChatGPT/Gemini/Claude/Copilot/Qwen, telling you whether each platform proactively recommends your brand.

Your Data โ†“
โœ… Brand Name โ€” Who you're checking
โœ… Each Recommendation Result โ€” Whether recommended + reason for recommendation
โœ… Ranking Position โ€” Where you rank in the recommendation list
โœ… Overall Score โ€” 0-5 pts; 5 pts = all 5 platforms recommend you
๐Ÿฉบ GEO Health Check

Is Your Site AI-Friendly?

AI analyzes your site content, structure, and technical configuration, generating a GEO Health Score with itemized optimization tips.

Your Data โ†“
โœ… Health Score โ€” 0-100 pts
โœ… 5 Major Dimension Scores โ€” Content Quality / Structured Data / Technical SEO / AI Readability / Authority
โœ… Issue List โ€” Exactly where the issues are
โœ… Optimization Tips โ€” How to fix each issue
๐Ÿ‘๏ธ AI Visibility Check

Can AI "See" Your Site?

Check whether your site can be discovered, understood, and recommended by AI in AI search scenarios.

Your Data โ†“
โœ… Visibility Score โ€” 0-100 pts
โœ… Discoverability โ€” Can AI find you
โœ… Understandability โ€” Can AI understand you
โœ… Recommendability โ€” Is AI willing to recommend you
๐Ÿ”ง Basic Check (Low Cost)

Meta Tags / Robots / Index Count

No AI calls โ€” pure technical checks. Fast and low quota cost, ideal for bulk calls.

Your Data โ†“
โœ… Meta Tags โ€” Whether title/description/og tags are complete
โœ… Robots.txt โ€” Whether AI crawlers are allowed
โœ… Index Count โ€” Search engine indexed page count
๐Ÿ’ก Each call only costs "Standard Call" quota

๐Ÿ“ In a Nutshell

๐ŸŽจ Data Format
All API responses return JSON data โ€” the format developers know best. Your dev team can read and display it directly in your own system.
๐Ÿ“Š Usage Tracking
Each response header automatically includes Used / Total Quota, making it easy to monitor remaining quota in real-time and remind you to renew when running low.
๐Ÿ”„ How to Use This Data
Embed in your product as a GEO feature โ†’ periodic checks and reports โ†’ monitor competitor GEO rankings โ†’ sell to your clients as a value-added service. The data is yours โ€” you decide how to present it.

๐Ÿท๏ธ White-Label Capabilities โ€” Your Brand, Your Product

Call the SilkGeo API for data, but your clients see entirely your brand, your product, your interface. They won't know SilkGeo is powering the capabilities behind the scenes.

๐Ÿšซ

No SilkGeo Branding in Returned Data

JSON responses contain only pure data: scores, recommendation results, optimization tips. No SilkGeo logo, no SilkGeo links, no third-party brand traces.

๐ŸŽจ

You Decide How to Present It

Build your own dashboard, embed in your product, generate your reports, send your emails. Once you have the data, the interface is entirely your design, and the brand is 100% yours.

๐Ÿ’ฐ

Your Pricing, Your Margin

You pay SilkGeo per-use, then resell to your clients under your brand and pricing. The margin is entirely under your control, and your clients only know they're using your product.

๐Ÿ’ก Typical Use Cases

SEO Agency
Package GEO checks as your own service, deliver reports to clients, and include it in your plans
SaaS Product
Add a "GEO Check" feature module to your product โ€” users never know SilkGeo is behind it
Web Agency
After building client websites, use the API for periodic GEO rank checks as a value-added maintenance service

Simple Pricing, Pick What You Need

AI Calls (invoking large models) and Standard Calls are metered separately โ€” you only pay for actual usage.

Free Trial
$0/mo
For trial and evaluation
  • AI Calls: 1/month
  • Standard Checks: 10/month
  • Community Support
Developer
$99/mo
Individual developers & small projects
  • AI Calls: 200/month
  • Standard Checks: 1,000/month
  • Max Concurrency: 2
  • Email Support
Unlimited
$699/mo
Large teams & high-frequency use
  • AI Calls: 1,500/month
  • Standard Checks: Unlimited
  • Max Concurrency: 10
  • Dedicated Support
  • Add-on pack: $40/100 calls

Three Steps to Integrate

1

Sign Up & Get Your API Key

After signing up for a SilkGeo account, an exclusive API Key is auto-generated in your dashboard (format: ysl_xxxxxxxx).

2

Send Your Request

Add X-API-Key in the request header, or pass it in via the query parameter ?api_key=.

curl -X POST http://silkgeo.com/api/v1/geo-simulate \
 -H "X-API-Key: ysl_your_api_key" \
 -H "Content-Type: application/json" \
 -d '{"brand":"Haidilao","industry":"Hotpot","url":"haidilao.com"}'
3

Handle the Response

All API responses use a unified JSON structure, containing success, data, and usage fields.

{
 "success": true,
 "data": { ... },
 "usage": {
 "ai_calls_used": 1,
 "ai_calls_limit": 200,
 "basic_calls_used": 0,
 "basic_calls_limit": 1000
 }
}

API Endpoints

All endpoints base URL: http://silkgeo.com/api/v1 ๏ฝœ Authentication: X-API-Key in the request header

๐Ÿ”ฅ AI Search Simulation (Core Capability)

POST /geo-simulate Simulate 5 AI Platform Recommendations AI Call

Enter brand and industry information, and the system auto-generates broad queries, simulating recommendation results across five major platforms: ChatGPT/Gemini/Claude/Copilot/Qwen. Core logic: When users don't mention the brand name, will AI proactively recommend you?

ParameterTypeRequiredDescription
brandstringRequiredBrand name, e.g. "Haidilao"
industrystringRequiredIndustry name, e.g. "Hotpot"
urlstringOptionalBrand website URL
keywordsstringOptionalKeywords, comma-separated
competitorsstringOptionalCompetitor names, comma-separated

Response Example:

{
 "success": true,
 "data": {
 "brand": "Haidilao",
 "industry": "Hotpot",
 "score": 3,
 "total_platforms": 5,
 "results": {
 "chatgpt": { "recommended": true, "reason": "..." },
 "wenxin": { "recommended": false, "reason": "..." },
 "kimi": { "recommended": true, "reason": "..." },
 "doubao": { "recommended": true, "reason": "..." },
 "deepseek": { "recommended": false, "reason": "..." }
 }
 }
}

๐Ÿ“Š GEO Health Check

POST /geo-audit 5-Dimension GEO Health Score AI Call

Evaluates GEO health across five dimensions โ€” AI discoverability, content structure, competitor gap, source authority level, and brand consistency โ€” and outputs an Optimization Checklist.

ParameterTypeRequiredDescription
brandstringRequiredBrand name
urlstringRequiredBrand website URL
industrystringOptionalIndustry name

Response Example:

{
 "success": true,
 "data": {
 "brand": "Haidilao",
 "score": 82,
 "dimensions": {
 "ai_discoverability": 85,
 "content_structure": 78,
 "competitor_gap": 80,
 "authority": 75,
 "brand_consistency": 90
 },
 "issues": ["Missing llms.txt file", "robots.txt blocking AI crawlers"],
 "suggestions": ["Add llms.txt", "Modify robots.txt to allow AI crawling"]
 }
}

๐Ÿ” AI Visibility Check

POST /ai-check Brand AI Search Visibility AI Call

Check your brand's Visibility Score in AI search results, returning citation details for each platform.

ParameterTypeRequiredDescription
keywordstringRequiredBrand name or keyword
urlstringOptionalBrand website URL

๐Ÿ†• AI Citation Tracking + Knowledge Graph (Advanced)

POST /citation-track AI Citation Tracking โ€” Is your brand cited by AI? What is cited? AI Call NEW

Enter a brand name, and the system auto-queries 5 AI platforms (ChatGPT/Claude/Copilot/Gemini/Qwen), tracking whether each platform cites your brand, which original text passage is cited, and how many times competitors are cited. This is the core metric of GEO optimization โ€” having a website is not enough; you also need to see whether AI will "talk about you".

ParameterTypeRequiredDescription
brandstringRequiredBrand name, e.g. "Haidilao"
urlstringOptionalBrand website URL
industrystringOptionalIndustry name, e.g. "Hotpot"
competitorsstringOptionalCompetitor names, comma-separated

Response Example:

{
 "success": true,
 "data": {
 "brand": "Haidilao",
 "citation_score": 80,
 "total_platforms": 5,
 "brand_mentions": 4,
 "mention_rate": "80.0%",
 "platforms": [
 {
 "platform": "ChatGPT",
 "brand_mentioned": true,
 "citation_snippet": "...Haidilao is renowned for its outstanding service experience...",
 "competitors_mentioned": ["Xiabu Xiabu"]
 }
 ],
 "competitor_comparison": [
 { "name": "Xiabu Xiabu", "platforms_mentioned": 3, "mention_rate": "60.0%" }
 ],
 "recommendations": ["Your brand's citation performance across AI platforms is excellent. Suggest maintaining continuous content updates."]
 }
}
POST /knowledge-graph Knowledge Graph Score โ€” Is Your Brand in the AI Knowledge Base? AI Call NEW

Deep-check your brand's position in the AI knowledge graph: Does AI identify your brand as an independent entity? What keywords/industries/scenarios is your brand associated with? Will AI proactively associate your brand when answering industry questions? How well is your site's structured data implemented? Returns ABCD four-tier scores with detailed optimization tips.

ParameterTypeRequiredDescription
brandstringRequiredBrand name, e.g. "Haidilao"
urlstringOptionalBrand website URL (will also check structured data when provided)
industrystringOptionalIndustry name

Response Example:

{
 "success": true,
 "data": {
 "brand": "Haidilao",
 "knowledge_graph_score": 75,
 "grade": "B",
 "entity_recognition": {
 "is_known_entity": true,
 "entity_type": "brand",
 "description": "Haidilao is a well-known Chinese hotpot chain brand...",
 "trust_level": "High",
 "data_freshness": "Relatively up-to-date"
 },
 "semantic_association": {
 "strength": 8,
 "top_of_mind": true,
 "reason": "Leading brand in the hotpot industry, high-frequency association when users mention hotpot",
 "content_gaps": ["Insufficient international store coverage information", "Missing digital transformation case studies"]
 },
 "related_keywords": ["Hotpot", "Service Experience", "Chain Restaurant"],
 "related_industries": ["Food & Beverage", "Chain", "Catering"],
 "related_scenarios": ["Friend gatherings", "Family gatherings", "Business dinners"],
 "competitors": ["Xiabu Xiabu", "Banu", "Xiaolongkan"],
 "structure_score": 70,
 "structure_issues": ["Missing JSON-LD structured data"],
 "recommendations": ["Brand is identified by AI, but association strength is weak..."]
 }
}

โš™๏ธ Basic Checks (Standard Call)

POST /meta-check Meta Tag Checker Standard Call

Check webpage Title, Description, Keywords, and other meta tags for specification compliance.

ParameterTypeRequiredDescription
urlstringRequiredWebpage URL to check
POST /robots.txt-check Robots & AI Crawler Check Standard Call

Check robots.txt configuration, determining whether AI crawlers (GPTBot/ClaudeBot, etc.) are blocked.

ParameterTypeRequiredDescription
urlstringRequiredWebsite homepage URL
GET /llms.txt-txt-generator Generate llms.txt Standard Call

Auto-generate an llms.txt file based on website content, helping AI models better understand the website.

ParameterTypeRequiredDescription
urlstringRequiredWebsite URL (query parameter)
GET /index-check Search Engine Index Count Query Standard Call

Query the indexed page count for a domain across major search engines.

ParameterTypeRequiredDescription
domainstringRequiredDomain to query (query parameter)

Error Codes Reference

HTTP Status CodeError CodeDescription
401MISSING_API_KEYMissing API Key. Please add X-API-Key in the request header.
401INVALID_API_KEYAPI Key is invalid or has been deactivated.
429QUOTA_EXCEEDEDCalls quota exhausted. Please upgrade your plan or purchase add-on packs.
429RATE_LIMITEDRequest frequency exceeded. Please reduce call frequency.
400MISSING_PARAMMissing required parameter.
500INTERNAL_ERRORInternal server error. Please try again later.

Every response includes X-RateLimit-AI-Used / X-RateLimit-AI-Limit / X-RateLimit-Basic-Used / X-RateLimit-Basic-Limit response headers, making it easy to monitor your quota in real-time.