API Access

Integrate Smart 8D AI into your quality management systems

Authentication

All API requests require authentication using Bearer tokens. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Note: API keys are available for Pro and Enterprise plans. Contact support@smart8d.ai to request access.

Base URL

https://api.smart8d.ai/v1

All endpoints are relative to this base URL.

API Endpoints

GET/api/reports

Retrieve a list of quality reports

Query Parameters

  • status - Filter by status (draft, active, closed)
  • search - Search reports by title
  • sortBy - Sort field (created_at, title, status)
  • order - Sort order (asc, desc)

Example Request

curl -X GET "https://api.smart8d.ai/v1/api/reports?status=active&sortBy=created_at&order=desc" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

[
  {
    "id": "uuid",
    "title": "8D Report - Component Failure",
    "status": "active",
    "created_at": "2026-03-01T10:00:00Z",
    "updated_at": "2026-03-01T15:30:00Z",
    "sections": { ... }
  }
]
GET/api/reports/{id}

Retrieve a specific report by ID

Example Request

curl -X GET "https://api.smart8d.ai/v1/api/reports/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY"
POST/api/reports

Create a new quality report

Request Body

{
  "title": "8D Report - Component Failure",
  "status": "draft",
  "sections": {
    "d1": { "team": [], "problem": "" },
    "d2": { "problem": "" },
    "d3": { "containment": "" },
    "d4": { "root_causes": [] },
    "d5": { "corrective_actions": [] },
    "d6": { "implementation": "" },
    "d7": { "prevention": "" },
    "d8": { "recognition": "" }
  }
}

Example Request

curl -X POST "https://api.smart8d.ai/v1/api/reports" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "8D Report - Component Failure",
    "status": "draft",
    "sections": { ... }
  }'
PATCH/api/reports/{id}

Update an existing report

curl -X PATCH "https://api.smart8d.ai/v1/api/reports/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Updated Title", "status": "active"}'

Rate Limits

100
Free Tier
requests/hour
1,000
Pro Tier
requests/hour
10,000
Enterprise
requests/hour

Rate limit headers are included in all responses: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Error Handling

API errors follow standard HTTP status codes:

  • 400 - Bad Request (invalid parameters)
  • 401 - Unauthorized (missing/invalid API key)
  • 403 - Forbidden (insufficient permissions)
  • 404 - Not Found (resource doesn't exist)
  • 429 - Too Many Requests (rate limit exceeded)
  • 500 - Internal Server Error

Error Response Format

{
  "error": "Error message description",
  "code": "ERROR_CODE",
  "details": { ... }
}

SDKs & Libraries

Official SDKs are coming soon. For now, use standard HTTP clients:

JavaScript/TypeScript

fetch('https://api.smart8d.ai/v1/api/reports', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})
.then(res => res.json())
.then(data => console.log(data));

Python

import requests

response = requests.get(
    'https://api.smart8d.ai/v1/api/reports',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
data = response.json()

Need Help?

For API access requests, technical questions, or to report issues, contact our developer support:

Email: api@smart8d.ai

Documentation: Visit Support Center