Public API v1 scope and exclusions
This is the bounded public/customer API v1 reference scope. It deliberately does not mirror all 249 operations in the generated route surface. Only stable customer-facing families listed below belong in the public reference. This page is the explicit inclusion and exclusion boundary; it is intentionally not an endpoint inventory and does not create endpoint pages.
Included families
| Family | Customer purpose |
|---|---|
| Authentication and identity | Sign-up, login, logout, current-user context |
| Capabilities and organization membership | Understand organization-scoped access and membership where exposed |
| Cases | Create, list, and work with case records |
| Evidence | Upload, inspect, and observe processing of case evidence |
| Search | Case/evidence-oriented search where the current schema exposes it |
| AI analysis | Supported chronology, clinical analysis, deviation, and causation workflows |
| Pipeline and report jobs | Observe, retry, or cancel documented asynchronous work |
| Reports and exports | Generate and retrieve customer work products |
| Health | Basic service health checks where publicly documented |
These families are curated for v1 because they support the customer case workflow and have customer-facing semantics. Exact customer-facing operations and schemas remain in the curated API reference, subject to this scope boundary.
A family being listed does not imply every route under a similar prefix is customer-supported. Internal route names, generated OpenAPI presence, or dashboard use do not promote an operation into public v1.
Explicitly excluded from public reference
The following route classes are excluded from public/customer API v1 even when operations exist in the generated OpenAPI surface:
/api/admin/*administration, incident, allocation, webhook, and AI control routes;- billing, checkout, subscription, finance, and plan-management routes;
- BAA, compliance, retention, security-event, training, and governance-control routes;
- deployment, infrastructure, monitor, observatory, and operational health detail routes;
- model registration/deployment, performance governance, sampling, and prompt/model registries;
- evidence-integrity litigation-hold, attestation, court-readiness, synthetic-media, and governance surfaces unless a separate guide explicitly adopts them;
- dashboard, landing, onboarding, demo, and other UI-only or dashboard-only routes;
- internal search recipes, support operations, and maintenance endpoints;
- webhooks, SDKs, shared staging environments, and cursor pagination unless authoritative current documentation declares them.
Excluded does not mean nonexistent. It means this customer documentation does not present the route as a general integration contract. Do not infer fields, statuses, credentials, or availability from route names alone.
Source: BluQube customer documentation
Document reference: docs/api/guides/api-scope.md