File size: 1,167 Bytes
00c1e8f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 | # API Documentation
## Overview
The API surface is designed around runtime health, model/tool dispatch, tenant-aware operations, audit/provenance, and domain workflows.
## Common conventions
- JSON request and response bodies.
- Tenant-aware endpoints should require explicit tenant context.
- Security-sensitive operations should fail closed.
- Clinical or biological outputs should include evidence/provenance where applicable.
## Endpoint groups
### Health
```http
GET /health
```
Returns service status and runtime metadata.
### Models and agents
```http
GET /models
POST /v1/inference
```
Lists available model adapters and submits inference requests.
### Consent and governance
```http
POST /v1/consent/grant
POST /v1/consent/revoke
GET /audit/events
```
Clinical and PHI-aware workflows should use explicit consent, policy, and audit records.
### Workflows
```http
POST /v1/workflows/run
GET /v1/workflows/{id}
```
Runs reproducible agent/tool pipelines and returns traceable outputs.
## OpenAPI
When the service is running, generate the OpenAPI schema from the application runtime and commit a versioned snapshot under `docs/openapi.json`.
|