Back to Home

API Documentation

Comprehensive API documentation for integrating with the E-ARI Platform. Build powerful applications and automate your AI readiness assessments.

Table of Contents

🔐 Authentication

All API requests require authentication using API keys. Include your API key in the request headers.

API Key Authentication

Include your API key in the Authorization header:

Authorization: Bearer your_api_key_here

Note: API keys are available for Enterprise customers. Contact support to obtain your API key.

📊 Assessment API

Create, manage, and retrieve AI readiness assessments programmatically.

POST /api/v1/assessments

Create a new AI readiness assessment

Request Body

{ "organization": "Your Organization", "industry": "Technology", "size": "Large", "responses": { "strategy": { "q1": "Strongly Agree", "q2": "Agree", "q3": "Neutral" }, "governance": { "q1": "Agree", "q2": "Strongly Agree" } } }

Response

200 Success

{ "success": true, "assessment_id": "assess_123456789", "organization": "Your Organization", "overall_score": 75.5, "pillar_scores": { "strategy": 80.0, "governance": 70.0, "technology": 75.0 }, "created_at": "2025-01-08T10:30:00Z" }
GET /api/v1/assessments/{assessment_id}

Retrieve assessment results and detailed analysis

Response

200 Success

{ "success": true, "assessment": { "id": "assess_123456789", "organization": "Your Organization", "overall_score": 75.5, "pillar_scores": {...}, "ai_insights": {...}, "recommendations": [...], "created_at": "2025-01-08T10:30:00Z" } }

🏢 Enterprise API

Manage enterprise features including user management, RBAC, and multi-tenancy.

GET /api/v1/enterprise/users

List all users in your organization

POST /api/v1/enterprise/users

Create a new user in your organization

GET /api/v1/enterprise/organizations

Get organization details and settings

🎯 Customer Success API

Manage onboarding, support tickets, and customer success metrics.

POST /api/v1/customer-success/onboarding/start

Start onboarding process for a user

GET /api/v1/customer-success/onboarding/progress

Get onboarding progress for a user

POST /api/v1/customer-success/support/tickets

Create a new support ticket

🔒 Privacy & Compliance API

Manage privacy rights, data residency, and compliance features.

POST /api/v1/privacy/data-export

Request data export for GDPR compliance

DELETE /api/v1/privacy/delete-account

Request account deletion (Right to be Forgotten)

GET /api/v1/data-residency/locations

Get available data residency options

⚡ Rate Limits

API requests are rate-limited to ensure fair usage and system stability.

Plan Requests per Minute Requests per Hour Requests per Day
Free 10 100 1,000
Professional 100 1,000 10,000
Enterprise 1,000 10,000 100,000

❌ Error Handling

All API errors follow a consistent format with appropriate HTTP status codes.

400 Bad Request

{ "error": "Invalid request parameters", "message": "The 'organization' field is required", "code": "MISSING_REQUIRED_FIELD" }

401 Unauthorized

{ "error": "Authentication required", "message": "Invalid or missing API key", "code": "INVALID_API_KEY" }

500 Internal Server Error

{ "error": "Internal server error", "message": "An unexpected error occurred", "code": "INTERNAL_ERROR" }

🔗 Webhooks

Receive real-time notifications about events in your E-ARI account.

Assessment Completed

Get notified when an assessment is completed and results are ready.

User Invited

Receive notifications when new users are invited to your organization.

Support Ticket Created

Get notified when support tickets are created or updated.

Onboarding Milestone

Track onboarding progress with milestone completion notifications.

Webhook Configuration

Configure webhooks in your Enterprise dashboard under Settings → Webhooks.

{ "url": "https://your-app.com/webhooks/e-ari", "events": ["assessment.completed", "user.invited"], "secret": "your_webhook_secret" }

📞 Support

Need help with API integration? Our team is here to assist you.