# Corva Platform API

**Canonical:** https://apis.io/apis/corva-ai/corva-platform-api/  
**Provider:** Corva AI — https://apis.io/providers/corva-ai/  
**Base URL:** https://api.corva.ai  
**Documentation:** https://dc-docs.corva.ai/docs/API/API%20Reference/platform-api

Corva Platform API is one of 3 APIs that [Corva AI](https://apis.io/providers/corva-ai/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Platform API, Assets, Wells, Rigs, and Swagger. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

The Corva Platform API serves platform entities and their relationships — wells, rigs, drillout units, programs, pads and frac fleets, together with users, dashboards, alerts, apps, tasks, files and API keys. It is where an integration resolves the asset_id that every Data API query filters on: read attributes.asset_id from GET /v2/wells, or the top-level id from GET /v2/assets. It publishes a Swagger 2.0 contract (version v2.222.1) with 513 paths, 771 operations and 574 definitions, rendered by Swagger UI.

## Operations (60 of 771)

| Method | Path | Summary |
|---|---|---|
| GET | `v2/ability_check/check_feature` | Check feature status for user |
| GET | `v2/ability_check/check_permission` | Check permission status for user |
| GET | `/v2/activities` | List activities |
| POST | `/v2/activities` | Create an activity |
| GET | `/v2/activities/{id}` | Show activity |
| PATCH | `/v2/activities/{id}` | Update an activity |
| DELETE | `/v2/activities/{id}` | Delete an activity |
| GET | `/v2/alerts/{alert_id}/activities` | List Alert Activities |
| GET | `/v1/alerts/{alert_id}/comments/` | List comments for alert |
| POST | `/v1/alerts/{alert_id}/comments/` | Create a comment for alert |
| GET | `/v1/alerts/{alert_id}/comments/{id}` | Show comment for alert |
| PATCH | `/v1/alerts/{alert_id}/comments/{id}` | Update an alert comment |
| DELETE | `/v1/alerts/{alert_id}/comments/{id}` | Delete an alert comment |
| GET | `/v1/alerts/{alert_id}/comments/{comment_id}/likes` | List likes for alert's comment |
| POST | `/v1/alerts/{alert_id}/comments/{comment_id}/likes/toggle` | Toggle a like for alert's comment |
| GET | `/v2/alerts/{alert_id}/comments` | List Alert Comments |
| POST | `/v2/alerts/{alert_id}/comments` | Create Alert Comment |
| GET | `/v1/alerts/{alert_id}/likes` | List likes for alert |
| POST | `/v1/alerts/{alert_id}/likes/toggle` | Toggle a like for alert |
| GET | `/v1/alerts/definitions` | List Alert Definitions |
| GET | `/v1/alerts/definitions/context` | Gather Alert Definition Context |
| POST | `/v1/alerts/definitions/trigger` | Trigger Alert |
| POST | `/v1/alerts/definitions/close` | Close Open Alerts |
| POST | `/v1/alerts/definitions/{alert_definition_id}/check` | Check Alert Definition in point of time |
| GET | `/v1/alerts/definitions/templates/{template_type}` | List Alert Definition Templates |
| POST | `/v1/alerts/definitions/{id}/save_as_template` | Save Alert Definition as Library Template |
| POST | `/v1/alerts/definitions/{alert_definition_id}/enable` | Enable Alert Definition Template |
| POST | `/v1/alerts/definitions/{alert_definition_id}/disable` | Disable Alert Definition Template |
| GET | `/v2/alerts/definitions` | List Alert Definitions |
| POST | `/v2/alerts/definitions` | Create Alert Definition |
| GET | `/v2/alerts/definitions/templates/{template_type}` | List Alert Definition Templates |
| GET | `/v2/alerts/definitions/{id}` | Get Alert Definition |
| PATCH | `/v2/alerts/definitions/{id}` | Update Alert Definition |
| DELETE | `/v2/alerts/definitions/{id}` | Delete Alert Definition |
| POST | `/v2/alerts/definitions/{id}/copy` | Copy Alert Definition |
| POST | `/v2/alerts/definitions/{id}/apply` | Apply Library Template To Alert Group |
| POST | `/v2/alerts/definitions/{id}/refresh` | Refresh Alert Definition From Library |
| GET | `/v2/alerts/definitions/{id}/refresh_preview` | Preview A Library Refresh |
| POST | `/v2/alerts/definitions/{id}/subscribe` | Subscribe to Alert Definition |
| POST | `/v2/alerts/definitions/{id}/unsubscribe` | Unsubscribe from Alert Definition |
| GET | `/v2/alert_groups/{alert_group_id}/alert_definitions` | List an Alert Group's Definitions |
| POST | `/v2/alert_groups/{alert_group_id}/alert_definitions` | Assign an Alert Definition to a Group |
| DELETE | `/v2/alert_groups/{alert_group_id}/alert_definitions/{id}` | Unassign an Alert Definition from a Group |
| POST | `/v2/alert_groups/{alert_group_id}/alert_definitions/bulk_create` | Bulk Assign Alert Definitions to a Group |
| DELETE | `/v2/alert_groups/{alert_group_id}/alert_definitions/bulk_destroy` | Bulk Unassign Alert Definitions from a Group |
| PUT | `/v2/alert_groups/{alert_group_id}/alert_definitions/bulk_replace` | Replace an Alert Group's Definitions |
| GET | `/v2/alert_groups` | List Alert Groups |
| POST | `/v2/alert_groups` | Create Alert Group |
| GET | `/v2/alert_groups/{id}` | Get Alert Group |
| PATCH | `/v2/alert_groups/{id}` | Update Alert Group |
| DELETE | `/v2/alert_groups/{id}` | Delete Alert Group |
| POST | `/v2/alert_groups/{id}/merge` | Merge Alert Group |
| GET | `/v2/alert_groups/{alert_group_id}/alert_group_users` | List Group Members |
| POST | `/v2/alert_groups/{alert_group_id}/alert_group_users` | Add Member to Group |
| DELETE | `/v2/alert_groups/{alert_group_id}/alert_group_users/{id}` | Remove Member from Group |
| GET | `/v2/alert_groups/{alert_group_id}/alert_group_scopes` | List Group Scopes |
| POST | `/v2/alert_groups/{alert_group_id}/alert_group_scopes` | Add Scope Target to Group |
| DELETE | `/v2/alert_groups/{alert_group_id}/alert_group_scopes/{id}` | Remove Scope Target from Group |
| GET | `/v2/alert_groups/{alert_group_id}/alert_group_configurations` | List Group Configurations |
| POST | `/v2/alert_groups/{alert_group_id}/alert_group_configurations` | Create Group Configuration |

…and 711 more operations. The page lists the first 250; the full set of 771 is in the OpenAPI linked below.

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/corva-ai/refs/heads/main/openapi/corva-ai-platform-api-openapi.yml
- **Documentation** — https://dc-docs.corva.ai/docs/API/API%20Reference/platform-api
- **APIReference** — https://dc-docs.corva.ai/docs/API/API%20Reference/platform-api
- **Swagger** — https://api.corva.ai/documentation/index.html
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/corva-ai/refs/heads/main/overlays/corva-ai-platform-api-overlay.yaml
- **GettingStarted** — https://dc-docs.corva.ai/docs/API/quickstart
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/corva-ai/refs/heads/main/apis.yml

## Other Corva AI APIs (2)

- [Corva Data API](https://apis.io/apis/corva-ai/corva-data-api/)
- [Corva Dev Center](https://apis.io/apis/corva-ai/corva-dev-center-api/)

## Tags

Platform API, Assets, Wells, Rigs, Swagger, Drilling

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/corva-ai/corva-platform-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/corva-ai/.