API Reference

Welcome to the Luffa API documentation. Our RESTful API provides programmatic access to all Luffa features, enabling you to integrate documentation management into your workflows seamlessly.

Base URL

All API requests should be made to:

https://api.luffa.dev/v1

Authentication

The Luffa API uses API keys for authentication. Include your API key in the Authorization header of each request:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.luffa.dev/v1/documents
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.luffa.dev/v1/documents

Get your API key →

Quick Start

Here's a simple example to get you started:

const response = await fetch('https://api.luffa.dev/v1/documents', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})

const documents = await response.json()
console.log(documents)
const response = await fetch('https://api.luffa.dev/v1/documents', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})

const documents = await response.json()
console.log(documents)

Rate Limits

The API has the following rate limits:

• Free tier: 1,000 requests per hour
• Pro tier: 10,000 requests per hour
• Enterprise: Custom limits available

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

SDKs and Libraries

We provide official SDKs for popular programming languages:

• JavaScript/TypeScript
• Python
• Go
• PHP

Endpoints Overview

Documents

• GET /documents - List all documents
• POST /documents - Create a new document
• GET /documents/{id} - Get a specific document
• PUT /documents/{id} - Update a document
• DELETE /documents/{id} - Delete a document

Search

• GET /search - Search across all documents
• POST /search/semantic - AI-powered semantic search

Analytics

• GET /analytics/views - Document view analytics
• GET /analytics/search - Search analytics

Need Help?

• Browse our API guides
• Check out best practices
• Join our Discord community
• Email us at support@luffa.dev