Skip to content
Browse docs

Quality modules

The 15 endpoints /api/v1 serves under Quality modules.

POST /api/v1/evals/runs

http
POST /api/v1/evals/runs
  • Auth: required (module: evals)
  • Body: { flowVersionId, suiteName, seed? }
  • 202

GET /api/v1/evals/runs

http
GET /api/v1/evals/runs
  • Query: ?flowVersionId=
  • 200

GET /api/v1/cost/summary

http
GET /api/v1/cost/summary
  • Auth: required (module: cost_attribution)
  • Query: ?from=&to=&groupBy=deployment|provider|day
  • 200

GET /api/v1/cost/summary/export

http
GET /api/v1/cost/summary/export
  • Auth: required (module: cost_attribution)
  • Query: same as GET /cost/summary
  • 200

GET /api/v1/cost/budget

http
GET /api/v1/cost/budget
  • Auth: required (module: cost_attribution)
  • Query: ?tenantId=
  • 200

POST /api/v1/cost/budget

http
POST /api/v1/cost/budget
  • Auth: required (module: cost_attribution)
  • Body: { tenantId, limitUsd }
  • 200

DELETE /api/v1/cost/budget

http
DELETE /api/v1/cost/budget
  • Auth: required (module: cost_attribution)
  • Query: ?tenantId=
  • 200

GET /api/v1/traces

http
GET /api/v1/traces
  • Auth: required (module: traces)
  • Query: ?tenantId=&deploymentId=&status=ok|error&from=&to=&page=&limit=20
  • 200
  • 404 — not a tenant member (PLAN-RULE-01)

POST /api/v1/retrieval/runs

http
POST /api/v1/retrieval/runs
  • Auth: required (module: retrieval_monitor)
  • Body: { deploymentId, windowHours? }
  • 202
  • 404 — deployment outside the caller's tenants (PLAN-RULE-01)

GET /api/v1/retrieval/runs

http
GET /api/v1/retrieval/runs
  • Auth: required (module: retrieval_monitor)
  • Query: ?deploymentId=
  • 200
  • 404 — deployment outside the caller's tenants (PLAN-RULE-01)

POST /api/v1/migrate/runs

http
POST /api/v1/migrate/runs
  • Auth: required (module: migrate)
  • Body: { fromFlowVersionId, toFlowVersionId }
  • 202
  • 404 — versions outside the caller's tenants (PLAN-RULE-01)
  • 422 — versions belong to different flows

GET /api/v1/migrate/runs

http
GET /api/v1/migrate/runs
  • Auth: required (module: migrate)
  • Query: ?flowId=
  • 200
  • 404 — flow outside the caller's tenants (PLAN-RULE-01)

POST /api/v1/copilot/runs

http
POST /api/v1/copilot/runs
  • Auth: required (module: copilot)
  • Body: { flowId, windowHours? }
  • 202
  • 404 — flow outside the caller's tenants (PLAN-RULE-01)
  • 422 — flow has no version to advise on

GET /api/v1/copilot/flows

http
GET /api/v1/copilot/flows
  • Auth: required (module: copilot)
  • Query: ?tenantId=
  • 200
  • 404 — not a tenant member (PLAN-RULE-01)

POST /api/v1/copilot/dismissals

http
POST /api/v1/copilot/dismissals
  • Auth: required (module: copilot)
  • Body: { flowId, rule, target, dismissed }
  • 200
  • 404 — flow outside the caller's tenants, or SwiftTune's own flow (PLAN-RULE-01)