API Reference

Ekobelens REST API Overview

Centralized endpoints for authentication, DRAM lifecycle management, organizational hierarchy, and user governance. Use this hub to navigate generated endpoint docs, schema exports, and operational guardrails.

Version 1.0

Download OpenAPI Spec

Base URLs & Service health

Environment	REST Base URL	Notes
Production	https://api.ekobelens.com/v1	Primary cluster with 99.9% uptime SLA
Staging	https://api-stg.ekobelens.com/v1	Mirrors prod schemas for pre-release testing

• All responses include request_id headers for tracing across services.
• Rate limiting is applied per workspace; throttled requests return 429 with a Retry-After header.
• API deployments are announced in #release-ops and reflected in the changelog below.

Modules at a glance

Authentication

Issue, refresh, and revoke JWT tokens with rotation controls for long-lived integrations.

Explore Auth endpoints →

DRAM Lifecycle

Model mitigation chapters, upload supporting data, and publish DRAM updates with audit trails.

View DRAM actions →

Organization & Users

Maintain organizations, roles, and user permissions while preserving hierarchical consistency.

Manage governance APIs →

Request & response pattern

Sample request

curl -X POST "$BASE_URL/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "your-strong-password"
  }'

Unified response

{
  "data": {
    "access_token": "<ACCESS_TOKEN>",
    "refresh_token": "<REFRESH_TOKEN>",
    "expires_in": 900
  },
  "request_id": "01J...",
  "meta": {
    "issued_at": "2024-03-08T06:12:34Z"
  }
}

All endpoints share the same error envelope, returning success: false, a human-readable message, and a collection of issues describing invalid fields.

Change log & support

• 2025-11-21 — Add document list
• 2025-11-16 — Enhance block update and move API documentation with detailed parameters, request body examples, and best practices
• 2025-11-16 — Enhance API documentation for creating child blocks with detailed parameters and examples
• 2025-11-15 — Add text editor API docs
• 2025-11-03 — Add DRAM chapter 2
• 2025-10-30 — Add request_id property to MethodologyListResponse definition
• 2025-10-30 — Add filters parameter to query for enhanced search functionality
• 2025-10-30 — Add methodology docs

Need help? Reach us at support@ekobelens.com or open an issue in ekobelens-docs.