EvidenceOS Platform Documentation — public technical documentation for the EvidenceOS platform API, integration guides, and developer reference.
Active. API documentation generated from OpenAPI specs. Integration guides authored by the platform team.
api/— OpenAPI 3.0 specifications for all public EvidenceOS APIsintegration/— Step-by-step integration guides (FHIR R4, DHIS2, OpenHIE, HL7)sdk/— SDK reference documentation (TypeScript, Python)authentication/— Authentication guide (Supabase JWT, Row Level Security patterns)webhooks/— Webhook event catalog and payload schemaschangelog/— Public API changelog (breaking changes, deprecations)
| API | Purpose | Auth |
|---|---|---|
| Evidence Capsule API | Read/write Evidence Capsules | JWT (institutional) |
| Recommendation API | Get clinical recommendations (Aya/BRIDGE-TBI) | JWT (facility) |
| SR Pipeline API | Submit papers for screening/extraction | JWT (research) |
| Audit API | Read-only audit trail access | JWT (compliance) |
| Tier | Rate limit | SLA |
|---|---|---|
| Research (free) | 1,000 req/day | Best-effort |
| Institutional | 100,000 req/day | 99.5% uptime |
| Enterprise | Unlimited | 99.9% uptime + dedicated support |
API documentation improvements (typos, clarifications, example requests) are welcome via pull request. Breaking change proposals require prior RFC (Request for Comment) discussion via issues.
CC-BY-4.0 for documentation. API client libraries: MIT.
EvidenceOS Platform Team — platform@evidenceos.com
evidence-capsules— Evidence Capsule schemaevidenceos-bridge-tbi— BRIDGE-TBI API usage examplesevidenceos-aya— Aya API usage examples