Back to Home
API Documentation
Integrate Opale's AI-powered website optimization into your applications
Getting Started
The Opale API allows you to programmatically analyze websites and generate AI Identity Cards.
Base URL
https://api.opale.ai/v1Rate Limits
- 100 requests per minute
- 1000 requests per hour
- 10000 requests per day
Authentication
All API requests require authentication using an API key in the header:
Authorization: Bearer YOUR_API_KEY
Content-Type: application/jsonGet your API key from the Dashboard Settings
Endpoints
POST
/analyzeAnalyze a website and generate an AI Identity Card
Request Body
{
"url": "https://example.com",
"options": {
"deep_scan": true,
"generate_schema": true,
"include_seo": true
}
}Response
{
"id": "site_abc123",
"url": "https://example.com",
"score": 85,
"ai_identity": {
"name": "Example Site",
"description": "...",
"capabilities": [...],
"schema": {...}
},
"recommendations": [...],
"created_at": "2025-01-06T..."
}GET
/sites/{id}Retrieve details of a previously analyzed site
Response
{
"id": "site_abc123",
"url": "https://example.com",
"analyses": [...],
"latest_score": 85,
"improvements": [...],
"updated_at": "2025-01-06T..."
}GET
/sitesList all analyzed sites for your account
Query Parameters
?limit=10&offset=0&sort=created_at&order=descError Handling
The API uses standard HTTP status codes to indicate success or failure:
| Status Code | Description |
|---|---|
| 200 | Success |
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid API key |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |
Error Response Format
{
"error": {
"code": "invalid_request",
"message": "The URL parameter is required",
"details": {...}
}
}SDKs & Libraries
Need Help?
For API support and questions:
- Email: api@opale.ai
- Discord: Join our community
- GitHub: Report issues