API Reference (Generated)
Source: OpenAPI schema for ClearlyOps Reconciliation API v0.2.0.
Auto-generated. Do not edit manually.
/api/v1/agent/capabilities
| Method |
Summary |
Description |
GET |
Get Capabilities |
List available agent capabilities with schemas. Query Parameters: - workspace_id (optional): Filter capabilities available to workspace |
/api/v1/agent/plans
| Method |
Summary |
Description |
POST |
Propose Plan |
Propose an agent plan for execution. Plan is evaluated against policies and may require approval. |
/api/v1/agent/plans/{plan_id}
| Method |
Summary |
Description |
GET |
Get Plan |
Get current status and details of an agent plan. |
/api/v1/agent/plans/{plan_id}/approve
| Method |
Summary |
Description |
POST |
Approve Plan |
Approve a pending agent plan. Plan transitions to approved status and can be executed. |
/api/v1/agent/plans/{plan_id}/execute
| Method |
Summary |
Description |
POST |
Execute Plan |
Execute an approved agent plan. Plan transitions to executing and steps are executed sequentially. Execution is asynchronous - use GET /api/v1/agent/plans/{plan_id} to poll status. |
/api/v1/agent/plans/{plan_id}/reject
| Method |
Summary |
Description |
POST |
Reject Plan |
Reject a pending agent plan. Plan transitions to denied status. |
/api/v1/approvals
| Method |
Summary |
Description |
GET |
List Approvals |
List approval requests for a workspace. |
/api/v1/approvals/{approval_id}/approve
| Method |
Summary |
Description |
POST |
Approve Request |
Approve a pending approval request. |
/api/v1/approvals/{approval_id}/reject
| Method |
Summary |
Description |
POST |
Reject Request |
Reject a pending approval request. |
/api/v1/datasets/upload
| Method |
Summary |
Description |
POST |
Upload File |
Upload a file and add it as an artifact to a dataset version. Creates a dataset version if workspace_id is provided, otherwise requires an existing dataset_version_id. |
/api/v1/datasets/versions
| Method |
Summary |
Description |
POST |
Create Dataset Version |
Create a new dataset version. |
/api/v1/kyc/submissions
| Method |
Summary |
Description |
POST |
Create Kyc Submission |
Submit KYC documents for verification. Per integration-contracts.md, this creates a KYC submission and emits ops.kyc.submitted event. The submission can then be approved/rejected via manual review endpoints. |
/api/v1/kyc/submissions/{kyc_submission_id}
| Method |
Summary |
Description |
GET |
Get Kyc Submission |
Get status of a KYC submission. Per integration-contracts.md, returns the current status of a KYC submission. |
/api/v1/kyc/submissions/{kyc_submission_id}/approve
| Method |
Summary |
Description |
POST |
Approve Kyc Submission |
Approve a KYC submission (manual review). Per integration-contracts.md, this emits ops.kyc.approved event. |
/api/v1/kyc/submissions/{kyc_submission_id}/reject
| Method |
Summary |
Description |
POST |
Reject Kyc Submission |
Reject a KYC submission (manual review). Per integration-contracts.md, this emits ops.kyc.rejected event. |
/api/v1/notifications/send
| Method |
Summary |
Description |
POST |
Send Notification |
|
/api/v1/notifications/{notification_id}
| Method |
Summary |
Description |
GET |
Get Notification |
|
/api/v1/payments/intents
| Method |
Summary |
Description |
POST |
Create Payment Intent |
|
/api/v1/payments/intents/{payment_intent_id}
| Method |
Summary |
Description |
GET |
Get Payment Intent |
|
/api/v1/payments/stripe/webhook
| Method |
Summary |
Description |
POST |
Stripe Webhook |
|
/api/v1/policies
| Method |
Summary |
Description |
GET |
List Policies |
List checkpoint policies for a workspace. |
POST |
Create Policy |
Create a checkpoint policy. Policy triggers approvals or notifications when conditions are met. |
/api/v1/policies/{policy_id}
| Method |
Summary |
Description |
PATCH |
Update Policy |
Update a checkpoint policy. Can enable/disable or modify trigger/action. |
/api/v1/runs
| Method |
Summary |
Description |
GET |
List Runs |
List reconciliation runs. Reads from materialized projections. Requires workspace_id filter. Returns runs ordered by created_at descending. |
POST |
Create Run |
Create a new reconciliation run. Creates a run that references two dataset versions for reconciliation. Idempotency: Provide X-Idempotency-Key header for safe retries. When an idempotency key is provided, the run_id is derived deterministically from the key, ensuring retries return the same run_id. |
/api/v1/runs/{run_id}
| Method |
Summary |
Description |
GET |
Get Run |
Get reconciliation run by ID. Reads from the materialized projection for performance. Returns 404 if projection not found. |
/api/v1/runs/{run_id}/complete
| Method |
Summary |
Description |
POST |
Complete Run |
Complete a reconciliation run with results. Transitions the run from STARTED to COMPLETED state. |
/api/v1/runs/{run_id}/fail
| Method |
Summary |
Description |
POST |
Fail Run |
Fail a reconciliation run. Transitions the run from CREATED or STARTED to FAILED state. |
/api/v1/runs/{run_id}/start
| Method |
Summary |
Description |
POST |
Start Run |
Start a reconciliation run. Transitions the run from CREATED to STARTED state. |
/api/v1/workspaces
| Method |
Summary |
Description |
GET |
List Workspaces |
List workspace summaries (most recent activity first). |
/api/v1/workspaces/{workspace_id}
| Method |
Summary |
Description |
GET |
Get Workspace |
Get workspace summary by ID. |
/health
| Method |
Summary |
Description |
GET |
Health |
Health check endpoint. Returns service health status including: - Service status - Database connectivity - Queue connectivity (if applicable) - Timestamp Per deployment-security.md, this endpoint is at /health and intentionally unversioned. |
/metrics
| Method |
Summary |
Description |
GET |
Metrics |
Prometheus metrics endpoint. Returns Prometheus-compatible metrics in text format. |
/version
| Method |
Summary |
Description |
GET |
Version |
Get API version. |