REST API Documentation

{
  "success": false,
  "error": "Error type",
  "message": "Human-readable error message",
  "details": {
    "additional": "context-specific information"
  }
}

// Login and analyse a document
async function analyseDocument(text, sourceUrl) {
  // First, authenticate
  const loginResponse = await fetch('/api/auth/login', {
    method: 'POST',
    headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
    body: new URLSearchParams({
      email: 'user@example.com',
      password: 'password'
    })
  });
  
  const { token } = await loginResponse.json();
  
  // Then analyze
  const analyzeResponse = await fetch('/api/v1/analyze', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ text, source_url: sourceUrl })
  });
  
  const result = await analyzeResponse.json();
  console.log('Analysis started:', result);
  
  // Listen for progress updates
  const eventSource = new EventSource(`/api/v1/progress/${result.session_id}`);
  eventSource.onmessage = (event) => {
    const progress = JSON.parse(event.data);
    console.log('Progress:', progress);
    
    if (progress.stage === 'complete') {
      eventSource.close();
      // Fetch final results
      fetchDocument(progress.document_id, token);
    }
  };
}

import requests
import json

class TLDRClient:
    def __init__(self, base_url, email, password):
        self.base_url = base_url
        self.token = self._authenticate(email, password)
    
    def _authenticate(self, email, password):
        response = requests.post(f"{self.base_url}/api/auth/login", data={
            'email': email,
            'password': password
        })
        return response.json()['token']
    
    def analyse(self, text, source_url=None, title=None):
        headers = {
            'Authorization': f'Bearer {self.token}',
            'Content-Type': 'application/json'
        }
        data = {'text': text}
        if source_url:
            data['source_url'] = source_url
        if title:
            data['title'] = title
            
        response = requests.post(
            f"{self.base_url}/api/v1/analyze", 
            headers=headers, 
            json=data
        )
        return response.json()
    
    def get_document(self, document_id):
        headers = {'Authorization': f'Bearer {self.token}'}
        response = requests.get(
            f"{self.base_url}/api/v1/document/{document_id}", 
            headers=headers
        )
        return response.json()

# Usage
client = TLDRClient('https://your-domain.com', 'user@example.com', 'password')
result = client.analyse('Your terms and conditions text here...')
print(f"Analysis started: {result['session_id']}")