Live Route Families
This page documents the current route families served by scripts/serve_client_portal.py. The generated service-contract page covers the registry-backed subset.
Report And Deliverables
| Route |
Method |
Purpose |
/api/client-report |
GET |
Interactive savings/audit report payload. |
/api/client-report/context |
GET |
Authoritative context, lineage, AI handoff, workbook posture, contract evidence, Domo takeover status. |
/api/client-report/queue |
POST |
Internal queue refresh for a governed scope. |
/api/client-report-pdf |
GET |
Report PDF export lane. |
/api/client-report-xlsx |
GET |
Final workbook export lane. |
/api/optimize |
GET |
Evidence-first optimization payload. |
/api/optimization-report-pdf |
POST |
Print-first optimization PDF export. |
Module Copilot
| Route |
Method |
Purpose |
/api/module-copilot |
POST |
Governed Azure OpenAI module assistant with deterministic fallback. |
/api/module-actions/execute |
POST |
Deterministic preview or execution path for module actions. |
Salesforce ITR Workbench
| Route |
Method |
Purpose |
/api/ops/it-requests/open-workbench |
GET |
Cached, paginated open ITR workbench list. |
/api/ops/it-requests/{request_number} |
GET |
Detail drawer payload. |
/api/ops/it-requests/{request_number}/run-plan |
POST |
Exact scope and queueability resolution. |
/api/ops/it-requests/{request_number}/queue-run |
POST |
Queue one exact governed run. |
/api/ops/it-requests/queue-runs/preview |
POST |
Preview bulk queue action. |
/api/ops/it-requests/queue-runs/execute |
POST |
Execute bulk queue action. |
/api/ops/it-requests/{request_number}/evidence-bundle |
GET |
Browser-safe evidence bundle. |
/api/ops/it-requests/{request_number}/search-documents |
GET |
Search-ready evidence documents. |
/api/ops/it-requests/{request_number}/evidence-refresh |
POST |
Backend materialization and chunk refresh. |
/api/ops/it-requests/sync/full-mirror |
POST |
Full Salesforce mirror refresh. |
Agent Workbench
| Route |
Method |
Purpose |
/api/agents/workspaces |
GET |
Lane, source, role, and policy profile metadata. |
/api/agents/tasks |
GET / POST |
List or create task ledger records. |
/api/agents/tasks/{task_id} |
GET |
Task detail. |
/api/agents/tasks/{task_id}/traces |
GET |
Task trace ledger. |
/api/agents/tasks/{task_id}/artifacts |
GET |
Task artifact ledger. |
/api/agents/tasks/{task_id}/approve |
POST |
Operator approval. |
/api/agents/tasks/{task_id}/run |
POST |
Local OpenAI Agents SDK execution hook. |
/api/agents/tasks/{task_id}/dispatch |
POST |
Service Bus / AKS dispatch seam. |
/api/agents/tasks/{task_id}/cancel |
POST |
Cancel task. |
/api/agents/tasks/{task_id}/retry |
POST |
Mark task for retry. |
/api/agents/tasks/{task_id}/rollback |
POST |
Request rollback/remediation. |
/api/agents/tasks/from-it-request/{request_number} |
POST |
Create an agent task from an ITR scope. |
Operations
| Route |
Method |
Purpose |
/api/system-health |
GET |
Protected internal runtime observability. |
/api/ops/issues |
GET / POST |
Internal employee issue inbox. |
Failure Semantics
Routes should return explicit blocked or unavailable states when live dependencies are missing. Do not report success for missing SDKs, unconfigured Service Bus, missing source credentials, ambiguous scopes, partial manifests, or absent exact contract evidence.