📚 ARDF API Documentation

Welcome to the ARDF (AI Resource Discovery Framework) API documentation. ARDF helps AI agents discover and execute 140+ verified APIs using semantic search.

🚀 Quick Start

Get started with ARDF in less than 5 minutes:

1. Get Your API Key

Sign up for a free account at ardf.dev/waitlist to receive your API key.

2. Make Your First Request

curl -X POST https://ardf.dev/api/skills/discover \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "intent": "send transactional emails",
    "top_k": 5
  }'

3. Get Results

You'll receive ranked API recommendations with trust scores, pricing, and quick-start code.

🔐 Authentication

ARDF uses API key authentication. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Free Tier: 100 discoveries/month, no credit card required.

Pro Tier ($29/mo): 5,000 discoveries/month with advanced features.

🔍 Discovery API

Semantic search for APIs based on natural language intent.

Request Body

Example Request

{
  "intent": "send transactional emails",
  "top_k": 5,
  "context": {
    "budget": "free_preferred",
    "reliability": "high"
  }
}

Example Response

{
  "query": "send transactional emails",
  "results": 1,
  "cached": false,
  "response_time_ms": 87,
  "skills": [
    {
      "name": "Resend Email API",
      "slug": "resend-email-api",
      "description": "Modern email API for developers. Send transactional emails with 99.9% deliverability.",
      "category": "api",
      "relevance_score": 0.95,
      "trust_score": 95,
      "verified": true,
      "pricing_model": "Freemium",
      "estimated_cost": "Free up to 100 emails/day, then $0.001 per email",
      "capabilities": [
        "transactional-email",
        "email-templates",
        "email-analytics",
        "webhooks"
      ],
      "quick_start": "npm install resend",
      "docs_url": "https://resend.com/docs",
      "why_relevant": "Matches: email, transactional, high deliverability"
    }
  ]
}

📋 Browse Skills API

Browse all available APIs with optional filtering.

Query Parameters

Example Request

GET /api/skills?verified=true&min_trust=90&limit=10

⚠️ Error Handling

ARDF uses conventional HTTP response codes:

Error Response Format

{
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "status": 401
}

⏱️ Rate Limits

Rate limits vary by plan:

Rate limit headers are included in all responses:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200

🌐 REST API Integration

Use ARDF from any programming language via our REST API.

JavaScript/Node.js

const response = await fetch('https://ardf.dev/api/skills/discover', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: JSON.stringify({
    intent: 'send transactional emails',
    top_k: 5
  })
});

const data = await response.json();
console.log(data.skills);

Python

import requests

response = requests.post(
    'https://ardf.dev/api/skills/discover',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    json={
        'intent': 'send transactional emails',
        'top_k': 5
    }
)

skills = response.json()['skills']
print(skills)

🦜 LangChain Integration

Coming Soon

Official LangChain integration is in development. Use the REST API for now.

🤖 AutoGPT Integration

Coming Soon

Official AutoGPT plugin is in development. Use the REST API for now.

⚡ CrewAI Integration

Coming Soon

Official CrewAI integration is in development. Use the REST API for now.

🔧 Microsoft Autogen Integration

Coming Soon

Official Autogen integration is in development. Use the REST API for now.

🦙 LlamaIndex Integration

Coming Soon

Official LlamaIndex integration is in development. Use the REST API for now.

📤 Publishing Your API

List your API in ARDF to reach 1,000+ AI agents instantly.

Steps to Publish

1. Visit the Publisher Guide
2. Submit your API spec (OpenAPI/Swagger JSON)
3. Auto-verification (we test, index, and embed your API)
4. Go live - agents start discovering your skill

Pricing for Publishers

🎯 Optimization Tips

Improve your API's trust score and discoverability:

Trust Score Components

• Uptime (40%): Maintain 99.9%+ uptime
• Latency P95 (20%): Keep response times under 200ms
• Success Rate (20%): Minimize 4xx/5xx errors
• Community Reviews (10%): Encourage user feedback
• Documentation (10%): Provide clear, comprehensive docs

Best Practices

• Use descriptive API names that match user intent
• Provide accurate pricing information
• Include quick-start code examples
• Respond to community feedback
• Keep your API documentation up-to-date

🛡️ Trust Score Algorithm

ARDF ranks APIs using a proprietary trust score (0-100) calculated from real-time metrics:

Trust Score =
  (Uptime × 0.40) +
  (Latency Score × 0.20) +
  (Success Rate × 0.20) +
  (Community Reviews × 0.10) +
  (Documentation Quality × 0.10)

Scores are updated in real-time based on actual API performance. Use the Trust Score Calculator to estimate your score.

💬 Support

Need help? We're here for you:

• Documentation: You're reading it!
• FAQ: Common Questions
• Email: [email protected]
• Status: status.ardf.dev