ClearlyOps API Documentation
ClearlyOps provides a control-plane API for data reconciliation, agent orchestration, payments, notifications, and KYC verification.
Getting Started
ClearlyOps exposes a RESTful API at /api/v1/*. All endpoints use JSON for request
and response bodies.
Base URL
| Environment | Base URL |
|---|---|
| Production | https://api.clearlyops.com/api/v1 |
| Staging | https://api-staging.clearlyops.com/api/v1 |
Authentication
Requests require a valid API key in the Authorization header:
Authorization: Bearer sk_your_api_key
Contact us to obtain API credentials.
API Reference
See the API Reference for complete endpoint documentation.
The OpenAPI Schema is also available for client generation.
Resources
| Resource | Description |
|---|---|
| Agent Plans | Propose, approve, and execute agent plans with policy evaluation |
| Workspaces | Multi-tenant workspace isolation |
| Datasets | File uploads and dataset version management |
| Runs | Reconciliation run lifecycle management |
| Payments | Stripe integration for payment processing |
| Notifications | Email notification delivery |
| KYC | Document submission and verification |
Support
For questions or issues, contact: hello@clearlyops.com