Reference — REST API¶
Endpoints below are generated from the live OpenAPI schema of
knovaryn.interfaces.rest.app — the same app knovaryn server serves.
Interactive docs ship at /docs and /openapi.json on a running server.
When KNOVARYN_API_TOKEN is set, every route except the /v1/health
probe requires a bearer token with the listed scope(s); see
security hardening. Error bodies are redacted.
| Method | Path | Summary |
|---|---|---|
POST |
/v1/demo |
Run Demo |
GET |
/v1/health |
Health |
GET |
/v1/jobs |
List Jobs |
GET |
/v1/jobs/{job_id} |
Get Job |
POST |
/v1/jobs/{job_id}/cancel |
Cancel Job |
POST |
/v1/jobs/{job_id}/resume |
Resume Job |
POST |
/v1/jobs/{job_id}/run |
Run Job |
GET |
/v1/projects |
List Projects |
POST |
/v1/projects |
Create Project |
GET |
/v1/projects/{project_id} |
Get Project |
GET |
/v1/projects/{project_id}/examples |
List Examples |
GET |
/v1/projects/{project_id}/examples/{example_id}/lineage |
Get Example Lineage |
POST |
/v1/projects/{project_id}/examples/{example_id}/review |
Review Example |
POST |
/v1/projects/{project_id}/export |
Export Dataset |
GET |
/v1/projects/{project_id}/license |
License Report |
POST |
/v1/projects/{project_id}/pipeline |
Start Pipeline |
POST |
/v1/projects/{project_id}/publish |
Publish Dataset |
GET |
/v1/projects/{project_id}/sources |
List Sources |
POST |
/v1/projects/{project_id}/sources |
Add Source |
GET |
/v1/projects/{project_id}/sources/{source_id} |
Inspect Source |
POST |
/v1/projects/{project_id}/validate |
Validate Dataset |
POST |
/v1/projects/{project_id}/version |
Create Version |