Developer Documentation & API

Tools, APIs, and integration guides for building and connecting AI-native websites.

⚡ Quick Start

Get started with the Digital Karma Web Federation in 5 minutes:

Create manifest.json
{ "name": "Your Site Name", "description": "Site description", "url": "https://yoursite.com", "federation_version": "7.0", "updated_utc": "2026-04-13T00:00:00Z", "contact": { "email": "admin@yoursite.com" }, "endpoints": { "health": "/ai/health.json", "catalog": "/ai/catalog.json", "karma": "/ai/karma.json", "federation": "/ai/federation.json" }, "related_sites": ["https://www.aiwebsitesystems.com"] }
Create health.json
{ "site": "https://yoursite.com", "status": "ok", "updated_utc": "2026-04-13T00:00:00Z", "metrics": { "pageCount": 20, "datasetCount": 3, "entityCount": 2 } }
Add Schema.org markup
<script type="application/ld+json"> { "@context": "https://schema.org", "@type": "WebSite", "name": "Your Site Name", "url": "https://yoursite.com" } </script>
Validate your implementation
$ curl https://yoursite.com/ai/manifest.json $ jq . ./ai/manifest.json
Submit to federation
Fill out the submission form and you're live!

📡 Public API Endpoints

Machine-readable data endpoints for AI agents and developers.

GET /ai/manifest.json

Site Identity & Discovery — Returns site metadata, available endpoints, and federation information.

curl https://www.digitalkarmaweb.com/ai/manifest.json

GET /ai/health.json

System Health Status — Real-time health metrics and operational status.

curl https://www.digitalkarmaweb.com/ai/health.json

GET /ai/catalog.json

Content Catalog — Complete inventory of site content and resources.

curl https://www.digitalkarmaweb.com/ai/catalog.json

GET /ai/karma.json

Digital Karma Score — Trust and quality scoring with signal breakdown.

curl https://www.digitalkarmaweb.com/ai/karma.json

GET /ai/federation.json

Federation Network Topology — Complete map of federated sites and relationships.

curl https://www.digitalkarmaweb.com/ai/federation.json

GET /llm.txt

LLM-Optimized Summary — Plain text site overview optimized for language models.

curl https://www.digitalkarmaweb.com/llm.txt

🛠️ Developer Tools

Federation Validator

Fetch each required endpoint directly and confirm the JSON parses cleanly.

$ jq . ./ai/manifest.json

Karma Score Calculator

Populate /ai/karma.json using the published weights in /specs/scoring-spec.md.

$ jq . ./ai/karma.json

Schema Validator

Validate your Schema.org JSON-LD with validator.schema.org.

https://validator.schema.org/

Link Checker

Check that every declared endpoint, dataset, and related site URL resolves correctly.

$ curl -I https://yoursite.com/llm.txt

💻 Integration Examples

Python: Fetch Federation Data

import requests

response = requests.get('https://www.digitalkarmaweb.com/ai/manifest.json')
manifest = response.json()
print(f"Site: {manifest['name']}")
print(f"Version: {manifest['federation_version']}")

JavaScript: Validate Karma Score

async function checkKarmaScore(siteUrl) {
  const response = await fetch(`${siteUrl}/ai/karma.json`);
  const karma = await response.json();
  console.log(`Karma Score: ${karma.digital_karma_score}`);
  return karma.digital_karma_score >= 0.70;
}

Bash: Automated Health Check

#!/bin/bash
health=$(curl -s "https://www.digitalkarmaweb.com/ai/health.json")
status=$(echo $health | jq -r '.status')
if [ "$status" = "healthy" ]; then echo "✓ Site is healthy"; fi

🌐 CORS & Cross-Origin Access

All API endpoints support CORS and can be accessed from any origin:

Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, OPTIONS
Access-Control-Allow-Headers: Content-Type

Need Help?

Have questions about integration or need technical support?

Browse Knowledge Base Contact Support