inou/static/api-docs.txt

79 lines
2.0 KiB
Plaintext

inou Health API
===============
Base URL: https://inou.com
Authentication: Bearer token in Authorization header, or token query parameter.
Your token is your dossier ID (16-character hex).
Example: Authorization: Bearer abc123def456789a
DATA TYPES
----------
- Imaging: MRI, CT, X-ray, ultrasound (DICOM format)
- Labs: Blood tests, metabolic panels, etc.
- Genome: SNP variants with clinical annotations
IMAGING ENDPOINTS
-----------------
GET /api/v1/dossiers
List all dossiers accessible to your account.
GET /api/v1/dossiers/{dossier}/entries?category=imaging
List imaging studies for a dossier.
GET /api/v1/dossiers/{dossier}/entries?parent={study}
List series in a study.
Optional: filter (e.g. T1, FLAIR, AX, SAG)
GET /api/v1/dossiers/{dossier}/entries?parent={series}
List slices in a series with position data.
GET /image/{slice}?token={dossier}
Fetch slice as PNG image.
Optional: ww (window width), wc (window center)
GET /contact-sheet.webp/{series}?token={dossier}
Fetch thumbnail grid for navigation.
Optional: ww, wc
LAB ENDPOINTS
-------------
GET /api/labs/tests?dossier={dossier}
List all available lab test names.
GET /api/labs/results?dossier={dossier}&names={names}
Get lab results for specified tests.
Required: names (comma-separated test names)
Optional: from, to (YYYY-MM-DD), latest (true/false)
GENOME ENDPOINTS
----------------
GET /api/categories?dossier={dossier}
Get top-level observation categories.
Optional: type=genome (for genome categories)
Optional: category={category} (for subcategories)
GET /api/genome?dossier={dossier}
Query genome variants.
Optional: gene (e.g. MTHFR, COMT)
Optional: search (gene, subcategory, or summary text)
Optional: category (filter by category)
Optional: rsids (comma-separated rs numbers)
Optional: min_magnitude (0-4)
Optional: include_hidden (true/false)
NAVIGATION FLOW
---------------
Imaging: dossiers → studies → series → slices → image
Labs: dossiers → tests → results
Genome: dossiers → categories → variants