API Reference Overview
Welcome to the Alactic AGI API Reference. This comprehensive guide provides detailed documentation for all API endpoints, authentication methods, and integration patterns.
What You'll Find Here
This API reference is organized into the following sections:
Authentication
- API key management
- OAuth 2.0 integration
- Security best practices
- Rate limiting and quotas
Document Processing
- Single document processing
- Batch document processing
- Real-time document analysis
- Custom extraction rules
Web Content Processing
- Web page scraping
- Content extraction
- Website monitoring
- Competitive intelligence
Intelligent Automation
- Workflow orchestration
- Custom automation rules
- Event-driven processing
- Integration webhooks
Data Management
- Data storage and retrieval
- Export functionality
- Data retention policies
- GDPR compliance
Quick Start
Authentication
All API requests require authentication using an API key:
curl -X POST https://api.alactic.io/v1/process \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"file_url": "https://example.com/document.pdf"}'
Python SDK
from alactic import AlacticClient
# Initialize client
client = AlacticClient(api_key="your-api-key")
# Process a document
result = client.process_document(
file_path="invoice.pdf",
task="extract_data"
)
print(result.data)
Node.js SDK
const Alactic = require('@alactic/sdk');
const client = new Alactic({
apiKey: 'your-api-key'
});
// Process a document
const result = await client.processDocument({
filePath: 'invoice.pdf',
task: 'extract_data'
});
console.log(result.data);
Base URL
All API endpoints are accessed via:
https://api.alactic.io/v1
Response Format
All API responses follow this standard format:
{
"success": true,
"data": {
// Response data
},
"metadata": {
"request_id": "req_abc123",
"timestamp": "2024-01-15T10:30:00Z",
"processing_time_ms": 1234
}
}
Error Handling
Error responses include detailed information:
{
"success": false,
"error": {
"code": "INVALID_REQUEST",
"message": "Missing required field: file_url",
"details": {
"field": "file_url",
"constraint": "required"
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": "2024-01-15T10:30:00Z"
}
}
Rate Limits
| Plan | Requests per Minute | Requests per Day |
|---|---|---|
| Pro | 60 | 10,000 |
| Pro+ | 120 | 25,000 |
| Enterprise | Custom | Custom |
Next Steps
- Authentication Guide - Learn how to authenticate your requests
- Document Processing API - Process documents programmatically
- Web Processing API - Extract web content at scale
- Webhooks - Set up event-driven integrations
- SDKs - Official SDK documentation
Support
Need help with the API?
Changelog
Stay updated with the latest API changes:
- API Changelog - Version history and updates
- Migration Guides - Upgrade between versions
- Deprecation Notices - Upcoming changes