Skip to main content

Parthenon API Reference

Interactive documentation for the Parthenon REST API — 785 endpoints powering cohort building, population-level estimation, patient-level prediction, pathway analysis, genomics, medical imaging, and health economics research on the OMOP Common Data Model v5.4.

Authentication

All endpoints require Laravel Sanctum Bearer token authentication unless marked public.

POST /api/v1/auth/login
Content-Type: application/json

{ "email": "you@example.com", "password": "your-password" }

The response includes a token field — pass it as Authorization: Bearer {token} on subsequent requests.

API Groups

GroupDescription
AuthenticationLogin, registration, password management
Cohort DefinitionsBuild and generate patient cohorts using Circe expressions
Concept SetsManage OMOP concept sets with vocabulary lookups
AnalysesIncidence rates, characterizations, estimations, predictions, pathways
Data SourcesConfigure CDM/vocabulary/results database connections
VocabularySearch concepts, browse hierarchies, map codes
Data QualityAchilles characterization and DQD heel checks
ImagingDICOM study management, DICOMweb integration, radiology NLP
GenomicsVariant queries, ClinVar annotations, gene-level analysis
HEORCost-effectiveness, budget impact, Markov modeling
AdministrationUsers, roles, permissions, system health, AI providers

Standards & Conventions

  • Response envelope: All responses wrap data in { "data": ... } with pagination metadata where applicable
  • Error format: { "message": "...", "errors": { "field": ["..."] } } with appropriate HTTP status codes
  • Pagination: ?page=N&per_page=N query parameters, responses include total, current_page, last_page
  • Rate limiting: Auth endpoints throttled at 5 requests / 15 minutes per IP
Try It Out

Each endpoint page has a Send API Request button — enter your Bearer token to test endpoints interactively.

Browse the API by group using the sidebar, or use the search bar to find specific endpoints.