Shaktix Docs
API Reference
Versioned launch-safe endpoints plus compatibility notes for legacy paths.
Stable v1 Endpoints
POST /api/v1/circuit-jobs
Create async generation or repair job for chat/workspace workflows.
GET /api/v1/circuit-jobs/{job_id}
Poll job state and retrieve simulation artifacts, guardrail metadata (`scope_source`, `scope_confidence`, `scope_reason_code`, `guardrail_action`), routing traces (`provider_path`, `attempt_count`, `provider`, `model`, `lane`), and structured failure metadata (`error_code`, `retryable`).
GET /api/v1/usage/summary
Usage, billing dimensions, and cap state for dashboard analytics.
GET /api/v1/notifications
Notification feed with read/unread mutation support.
GET /api/v1/status
System health, capacity alerts, and incident feed snapshot.
Legacy Compatibility Endpoints
These paths emit deprecation headers (`Deprecation`, `Sunset`, replacement hints). After sunset inside freeze window, requests are rejected with `410 compatibility_endpoint_retired`.
POST /api/generate
Deprecated. Use `POST /api/v1/circuit-jobs`.
POST /api/simulate
Deprecated. Use async job orchestration flow.
POST /api/analyze-image
Deprecated. Use `POST /api/v1/circuit-jobs` or `/api/v1/vision/analyze`.
POST /api/repair-from-image
Deprecated. Use `POST /api/v1/circuit-jobs`.
POST /api/export/pdf
Deprecated compatibility path pending v1 export migration.