Flowcept provides a read-only REST API for querying provenance data from MongoDB.
List endpoints for workflows, tasks, and objects return results sorted ascending by the first available date/timestamp field.
/api/v1
- Swagger UI:
/docs - ReDoc:
/redoc - OpenAPI JSON:
/openapi.json
uvicorn flowcept.webservice.main:app --host 0.0.0.0 --port 5000- Health
-
GET /api/v1/health/live-GET /api/v1/health/ready - Workflows
-
GET /api/v1/workflows-GET /api/v1/workflows/{workflow_id}-POST /api/v1/workflows/query-POST /api/v1/workflows/{workflow_id}/reports/workflow-card/download - Tasks
-
GET /api/v1/tasks-GET /api/v1/tasks/{task_id}-GET /api/v1/tasks/by_workflow/{workflow_id}-POST /api/v1/tasks/query - Objects
-
GET /api/v1/objects-GET /api/v1/objects/{object_id}-GET /api/v1/objects/{object_id}/versions/{version}-GET /api/v1/objects/{object_id}/download-GET /api/v1/objects/{object_id}/versions/{version}/download-GET /api/v1/objects/{object_id}/history-POST /api/v1/objects/query - Datasets
-
GET /api/v1/datasets-GET /api/v1/datasets/{object_id}-GET /api/v1/datasets/{object_id}/versions/{version}-GET /api/v1/datasets/{object_id}/download-POST /api/v1/datasets/query - Models
-
GET /api/v1/models-GET /api/v1/models/{object_id}-GET /api/v1/models/{object_id}/versions/{version}-GET /api/v1/models/{object_id}/download-POST /api/v1/models/query
{
"filter": {"workflow_id": "wf_123"},
"projection": ["task_id", "started_at", "ended_at"],
"sort": [{"field": "started_at", "order": -1}],
"limit": 100,
"aggregation": null
}Generate static OpenAPI files:
python docs/openapi/scripts/generate_openapi.pyFiles generated:
docs/openapi/flowcept-openapi.jsondocs/openapi/flowcept-openapi.yaml
Because docs/conf.py includes html_extra_path = [\"openapi\"], the files are published at the documentation
root on ReadTheDocs and can be downloaded from:
https://flowcept.readthedocs.io/en/latest/flowcept-openapi.yamlhttps://flowcept.readthedocs.io/en/latest/flowcept-openapi.json