Overview of XEO
Welcome to the XEOSystem Developer Documentation. XEO (X Ecosystem Optimization) provides a programmable semantic substrate allowing developers to automate entity stability scoring, latent space positioning checks, and presence audits across all leading AI engines.
Utilize our high-performance Cloudflare-powered APIs to ingestion web URLs, extract clean schemas, parse complex PDFs, and verify retrieval status in real-time.
Quick Start Guide (5 mins)
Get started with the XEO Ingestion and Analysis API in three simple steps.
Step 1: Obtain your API Token
Initialize your brand substrate via the Onboarding Form. Save your secure 32-character token prefixed with xeo_.
Step 2: Ingest Content
Make a HTTP POST request to ingestion-worker to embed and register a URL or raw text document:
curl -X POST "https://xeosystem-ingestion-worker.saggarsonny.workers.dev/api/ingest" \
-H "Authorization: Bearer YOUR_XEO_TOKEN" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com"}'
Step 3: Trigger XEO Analysis
Run the full 6-layer optimization checks and generate deliverable results:
curl -X POST "https://xeosystem-xeo-core-worker.saggarsonny.workers.dev/api/analyze" \
-H "Authorization: Bearer YOUR_XEO_TOKEN" \
-H "Content-Type: application/json" \
-d '{"clientId": "YOUR_CLIENT_ID"}'
Authentication
All API endpoints require a secure bearer token in the HTTP Authorization header.
Authorization: Bearer xeo_your_secure_api_token_here
Keep your token secret. Do not expose it in client-side code repositories or public workspaces.
Endpoints Reference
| Endpoint | Method | Description |
|---|---|---|
/api/ingest |
POST | Ingests text content or crawls a website URL, processes chunking, computes vectorized embeddings, and upserts into Vectorize. |
/api/analyze |
POST | Orchestrates the 6-layer optimization (GEO, LEO, MEO, PEO, AEO, TEO) using Fallback LLMs. |
/api/client/data |
GET | Fetches current brand profiles, scores, semantic maps, and a list of generated deliverables. |
Code Snippets
JavaScript
// Ingest Web URL to Vectorize
fetch('https://xeosystem-ingestion-worker.saggarsonny.workers.dev/api/ingest', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer YOUR_XEO_TOKEN'
},
body: JSON.stringify({ url: 'https://hive.baby' })
})
.then(res => res.json())
.then(data => console.log('Ingestion output:', data));
Python
import requests
url = "https://xeosystem-ingestion-worker.saggarsonny.workers.dev/api/ingest"
headers = {
"Authorization": "Bearer YOUR_XEO_TOKEN",
"Content-Type": "application/json"
}
payload = {
"url": "https://hive.baby"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())