Generate AI Site Documentation
Preview Output
{
"v": "1.0",
"d": "example.com",
"t": 1737374400,
"p": [
{
"u": "/",
"f": "home",
"a": ["nav", "search"],
"n": ["/products", "/about", "/contact"]
},
{
"u": "/products",
"f": "catalog",
"a": ["filter", "sort", "add_cart"],
"p": ["category", "price_range"],
"n": ["/products/{id}", "/checkout"]
},
{
"u": "/products/{id}",
"f": "detail",
"a": ["add_cart", "review", "share"],
"d": "dynamic",
"n": ["/checkout", "/products"]
},
{
"u": "/api/v1/search",
"f": "api_search",
"m": ["GET", "POST"],
"p": ["q", "limit", "offset"],
"r": "json_array"
}
],
"m": {
"auth": "optional",
"rate": "100/min",
"lang": ["en", "es", "fr"]
}
}
Generation History
example.com
2025-01-20 10:30:00
AIDOC
2.3 KB • 87% token reduction
shop.example.com
2025-01-20 09:15:00
AIDOC
4.1 KB • 91% token reduction
docs.example.com
2025-01-19 14:20:00
AIDOC
1.8 KB • 89% token reduction
Format Efficiency Comparison
| Format | File Size | Estimated Tokens | Efficiency |
|---|---|---|---|
| XML Sitemap | 18.5 KB | ~4,200 | Baseline |
| AIDOC | 2.3 KB | ~520 | 87% reduction |
| Compressed AIDOC | 0.9 KB | ~520 | 95% reduction |
Traditional Sitemap.xml
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://example.com/</loc>
<lastmod>2025-01-20</lastmod>
<changefreq>daily</changefreq>
<priority>1.0</priority>
</url>
<url>
<loc>https://example.com/products</loc>
<lastmod>2025-01-20</lastmod>
<changefreq>daily</changefreq>
<priority>0.8</priority>
</url>
<!-- ... more URLs ... -->
</urlset>
AIDOC Format
{
"v": "1.0",
"d": "example.com",
"t": 1737374400,
"p": [
{
"u": "/",
"f": "home",
"a": ["nav", "search"],
"n": ["/products", "/about"]
},
{
"u": "/products",
"f": "catalog",
"a": ["filter", "sort"],
"n": ["/products/{id}"]
}
]
}
AIDOC Format Specification
Overview
AIDOC (AI Documentation) is a token-optimized format designed specifically for AI agents to efficiently navigate and understand website structure. It reduces token consumption by 85-95% compared to traditional sitemaps.
Key Structure
v: Versiond: Domaint: Timestamp (Unix)p: Pages arraym: Metadata
Page Object Fields
u: URL pathf: Function/purposea: Available actionsp: Parametersn: Navigation linksm: HTTP methods (for APIs)r: Response typed: Dynamic content flag
Benefits for AI Agents
- Immediate understanding of page functionality
- Pre-mapped navigation paths
- Known action capabilities per page
- API endpoint discovery without crawling
- Minimal token usage for site comprehension
Conversion Plugins
Optional plugins available for converting AIDOC to:
- Human-readable Markdown documentation
- Traditional XML sitemaps
- OpenAPI specifications (for API endpoints)
- GraphQL schemas
AIDOC System Workflow
Complete process flow from website crawling to AI agent consumption
75%
Scroll to pan
INPUT PHASE
Website URL
https://example.com
Configuration
Depth: 3, APIs: Yes
→
CRAWLING PHASE
Web Crawler
Page discovery, Forms
Content Analyzer
Extract actions, Nav
Raw Data
~500KB
→
GENERATION PHASE
AIDOC Compiler
Compress structure
Token Optimizer
Single-letter keys
AIDOC File
2.3KB, ~520 tokens
→
CONSUMPTION PHASE
AI Agent Access
GET /site.aidoc
Agent Navigation
Pre-mapped paths
Task Execution
Direct navigation
Traditional Sitemap
Size:
18.5 KB
Tokens:
~4,200
Parse:
~250ms
AIDOC Format
Size:
2.3 KB
Tokens:
~520
Parse:
~15ms
Efficiency Gains
Token Cut:
87%
Speed:
16x faster
Cost Cut:
85-95%
Input
Processing
Output
Storage
AI Agent