Skip to main content

Choose the Right API

Corva exposes two HTTP APIs. Most data workflows use both: the Platform API identifies an asset, and the Data API returns operational records for that asset.

Platform API

Base URL: https://api.corva.ai

Use the Platform API for platform entities and relationships, including:

  • Wells and their asset_id values
  • Rigs and drillout units
  • Programs and pads
  • Frac fleets
  • Status, state, and visibility metadata

A common first request is GET /v2/wells. Use GET /v2/assets?types[]=well instead when you need mixed asset types, parent/child hierarchy, or an exact API-number lookup. The well discovery guide explains the different IDs returned by these endpoints.

Data API

Base URL: https://data.corva.ai

Use the Data API for records stored in Corva datasets, including:

  • One-second operational data
  • Engineering calculations and metrics
  • Time- and depth-based datasets
  • Reference datasets
  • Aggregation queries
  • Writes to permitted customer datasets, in batches of no more than 1,000 records

Most reads use GET /api/v1/data/{provider}/{dataset}/ and filter by asset_id or company_id.

Dev Center API clients

Frontend applications running in Dev Center can use the authenticated clients from @corva/ui:

  • corvaAPI calls the Platform API.
  • corvaDataAPI calls the Data API.
  • socketClient subscribes to newly arriving dataset records.

These clients are covered under API Clients for Dev Center Apps.

Decision table

QuestionRecommended interface
What is the asset ID for this well?Platform API
What records exist in corva#wits for the well?Data API
What datasets can my company access?Data API dataset endpoints
How do I calculate a grouped or projected result?Data API aggregation endpoints
How does my frontend app receive the next record?socketClient
How does my frontend app make authenticated HTTP requests?corvaAPI or corvaDataAPI