API Documentation

Lydaro provides a REST API for integrating with external systems.

Quick Start

1. Authentication — Get your API key
2. API Overview — Understand design principles
3. Endpoints — Reference for each endpoint
4. Error Handling — Handle API errors gracefully

API Versions

Currently: v1

• Base URL: https://lydaro.app/api
• Format: JSON
• Auth: Supabase session cookie (browser) or API key (future)

Endpoints

Risks

• GET /export/risks — Export risk list as CSV
• GET /export/assessment-history — Export assessment history
• GET /export/quality-report — Export quality report

Billing

• GET /billing/session — Get Stripe session details
• GET /billing/portal — Create billing portal session

Licensing

• GET /licensing/status — Get license and usage status

Projects & Organisations

• Projects — List and manage projects
• Organisations — Organisation management

Risk Workflow

• Risk Responses — Manage risk responses
• Risk Reviews — Manage risk reviews

Webhooks

• POST /webhooks/stripe — Stripe event receiver

OpenAPI Specification

Machine-readable API spec: openapi.json

Authentication

API requests from the browser use Supabase session cookies (set on login). All protected endpoints return 401 if no valid session is present.

Error Handling

All errors follow this format:

{
  "error": "Descriptive error message"
}

Error reference

Support

• Email: support@lydaro.app