Documentation menu

Reference

Cloud API

REST API reference for integrating Ontoly Cloud into your workflows — reports, evidence, and project management.

Authentication

All API requests require a Bearer token or API key. Generate API keys in your organization settings at cloud.ontoly.xyz/settings/api-keys. Include the key in the Authorization header.

TERMINAL
Authorization: Bearer <your-api-key>

# Or as a query parameter for webhooks:
?api_key=<your-api-key>

Verify endpoints

Endpoints for triggering and retrieving verification reports.

TERMINAL
POST   /api/v1/verify                  # trigger verification
GET    /api/v1/verify/:projectId/latest # latest report
GET    /api/v1/verify/:reportId         # specific report
GET    /api/v1/verify/:reportId/findings # report findings

Review endpoints

Endpoints for managing graph diffs and PR reviews.

TERMINAL
POST   /api/v1/review/diff              # compute graph diff
GET    /api/v1/review/:projectId/prs     # list PR reviews
GET    /api/v1/review/:reviewId          # specific review

Discover endpoints

Endpoints for graph exploration and evidence retrieval.

TERMINAL
GET    /api/v1/discover/:projectId/graph    # graph data
GET    /api/v1/discover/:projectId/search    # semantic search
GET    /api/v1/discover/:projectId/node/:id  # node details
POST   /api/v1/discover/:projectId/evidence  # evidence pack

Architect endpoints

Endpoints for health timeline, trends, and AI-powered analysis.

TERMINAL
GET    /api/v1/architect/:projectId/health    # health timeline
GET    /api/v1/architect/:projectId/trends     # detected trends
POST   /api/v1/architect/:projectId/simulate   # migration sim
POST   /api/v1/architect/:projectId/chat       # AI chat

Project and organization

Endpoints for managing projects, organizations, and settings.

TERMINAL
GET    /api/v1/projects                 # list projects
POST   /api/v1/projects                 # create project
GET    /api/v1/projects/:id              # project details
DELETE /api/v1/projects/:id              # remove project
GET    /api/v1/organization              # org details
GET    /api/v1/organization/members      # list members