Corva data contract | PatchOps Knowledge

Provenance

PublisherCorva

API basehttps://api.corva.ai/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (API key)

Methods (42)

getWellsWithAssetIds

read

Find wells and asset IDs to seed drilling or completion workflows.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number",
      "examples": [
        10000
      ],
      "description": "Maximum wells to return."
    },
    "verbose": {
      "type": "boolean",
      "description": "Include verbose payloads."
    }
  },
  "additionalProperties": true
}

Returns { asset_id, name, company_id } array. Filter locally by name.

getDrillingWitsForPeriod

read

Retrieve drilling WITS data for an explicit time window.

Required paramsassetIdstartTimeendTime

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "assetId": {
      "type": "number",
      "examples": [
        87507900
      ],
      "description": "Corva asset ID."
    },
    "startTime": {
      "type": "string",
      "examples": [
        "2025-12-05T00:00:00Z"
      ],
      "description": "Inclusive ISO start time."
    },
    "endTime": {
      "type": "string",
      "examples": [
        "2025-12-12T00:00:00Z"
      ],
      "description": "Exclusive ISO end time."
    },
    "verbose": {
      "type": "boolean",
      "description": "Include verbose payloads."
    }
  },
  "additionalProperties": true,
  "required": [
    "assetId",
    "startTime",
    "endTime"
  ]
}

Resolution auto-selected. wits.rows, wits.rowCount, wits.datasetUsed available.

getDrillingWits
read
Get WITS by resolution selector (windowMinutes). Less precise than getDrillingWitsForPeriod.
Required paramsassetId
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "assetId": {}
  },
  "additionalProperties": true,
  "required": [
    "assetId"
  ]
}
```
windowMinutes = RESOLUTION: ≤120=1m, ≤10080=30m, ≤43200=6h.
getWells
read
List wells with optional filtering by field, operator, or status
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

getWellDetails

read

Get detailed information for one or multiple wells by ID

Required paramswellId or wellIds

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "wellId": {},
    "wellIds": {}
  },
  "additionalProperties": true,
  "allOf": [
    {
      "anyOf": [
        {
          "required": [
            "wellId"
          ]
        },
        {
          "required": [
            "wellIds"
          ]
        }
      ]
    }
  ]
}

getRigs

read

List rigs for the current tenant.

Entitiesrig

Input schema

{
  "type": "object",
  "properties": {
    "company": {
      "type": "number",
      "examples": [
        522
      ],
      "description": "Company filter."
    },
    "hasActiveWell": {
      "type": "boolean",
      "examples": [
        true
      ],
      "description": "Only rigs with active wells."
    },
    "page": {
      "type": "number",
      "description": "Page number."
    },
    "perPage": {
      "type": "number",
      "description": "Results per page."
    }
  },
  "additionalProperties": true
}

getRigById

read

Get a single rig by ID

Required paramsrigId

Entitiesrig

Input schema

{
  "type": "object",
  "properties": {
    "rigId": {}
  },
  "additionalProperties": true,
  "required": [
    "rigId"
  ]
}

getRigActiveWell

read

Resolve the active well and cache data for a rig.

Required paramsrigId

Entitiesrig, well

Input schema

{
  "type": "object",
  "properties": {
    "rigId": {
      "type": "number",
      "examples": [
        3810
      ],
      "description": "Rig identifier."
    }
  },
  "additionalProperties": true,
  "required": [
    "rigId"
  ]
}

getWellsForRig

read

Get all wells associated with a rig

Required paramsrigId

Entitiesrig, well

Input schema

{
  "type": "object",
  "properties": {
    "rigId": {}
  },
  "additionalProperties": true,
  "required": [
    "rigId"
  ]
}

getPads

read

List drilling pads

Entitiespad, well

Input schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}

getPadById

read

Get a single pad by ID

Required paramspadId

Entitiespad, well

Input schema

{
  "type": "object",
  "properties": {
    "padId": {}
  },
  "additionalProperties": true,
  "required": [
    "padId"
  ]
}

getWellsForPad

read

Get all wells on a pad

Required paramspadId

Entitiespad, well

Input schema

{
  "type": "object",
  "properties": {
    "padId": {}
  },
  "additionalProperties": true,
  "required": [
    "padId"
  ]
}

getPadActiveWells

read

Get all active wells on a pad

Required paramspadId

Entitiespad, well

Input schema

{
  "type": "object",
  "properties": {
    "padId": {}
  },
  "additionalProperties": true,
  "required": [
    "padId"
  ]
}

getCompletionData

read

Get completion data for a well (Corva).

Required paramsassetId

Entitiescompletion

Input schema

{
  "type": "object",
  "properties": {
    "assetId": {}
  },
  "additionalProperties": true,
  "required": [
    "assetId"
  ]
}

getFracFleets
read
List frac fleets
Entitiesfrac_job, completion, rig
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

getFracFleetById

read

Get a single frac fleet by ID

Required paramsfleetId

Entitiesfrac_job, completion, rig

Input schema

{
  "type": "object",
  "properties": {
    "fleetId": {}
  },
  "additionalProperties": true,
  "required": [
    "fleetId"
  ]
}

getFracFleetActiveWell
read
Get active well and well cache data for a frac fleet (completion WITS, stages)
Required paramsfleetId
Entitiesfrac_job, completion, rig, well
Input schema
```
{
  "type": "object",
  "properties": {
    "fleetId": {}
  },
  "additionalProperties": true,
  "required": [
    "fleetId"
  ]
}
```
getWellsForFracFleet
read
Get all wells associated with a frac fleet
Required paramsfleetId
Entitiesfrac_job, completion, rig, well
Input schema
```
{
  "type": "object",
  "properties": {
    "fleetId": {}
  },
  "additionalProperties": true,
  "required": [
    "fleetId"
  ]
}
```

getWirelines

read

List wireline operations

Entitiesrig

Input schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}

getWirelineById

read

Get a single wireline by ID

Required paramswirelineId

Entitiesrig

Input schema

{
  "type": "object",
  "properties": {
    "wirelineId": {}
  },
  "additionalProperties": true,
  "required": [
    "wirelineId"
  ]
}

getWirelineActiveWell
read
Get active well and well cache data for a wireline (wireline WITS, perforations)
Required paramswirelineId
Entitiesrig, well
Input schema
```
{
  "type": "object",
  "properties": {
    "wirelineId": {}
  },
  "additionalProperties": true,
  "required": [
    "wirelineId"
  ]
}
```

getWellsForWireline

read

Get all wells associated with a wireline

Required paramswirelineId

Entitiesrig, well

Input schema

{
  "type": "object",
  "properties": {
    "wirelineId": {}
  },
  "additionalProperties": true,
  "required": [
    "wirelineId"
  ]
}

getDrilloutUnits
read
List drillout units
Entitiesunit, lease, rig
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

getDrilloutUnitById

read

Get a single drillout unit by ID

Required paramsunitId

Entitiesunit, lease, rig

Input schema

{
  "type": "object",
  "properties": {
    "unitId": {}
  },
  "additionalProperties": true,
  "required": [
    "unitId"
  ]
}

getDrilloutUnitActiveWell
read
Get active well and well cache data for a drillout unit (drillout WITS, plugs)
Required paramsunitId
Entitiesunit, lease, rig, well
Input schema
```
{
  "type": "object",
  "properties": {
    "unitId": {}
  },
  "additionalProperties": true,
  "required": [
    "unitId"
  ]
}
```
getWellsForDrilloutUnit
read
Get all wells associated with a drillout unit
Required paramsunitId
Entitiesunit, lease, rig, well
Input schema
```
{
  "type": "object",
  "properties": {
    "unitId": {}
  },
  "additionalProperties": true,
  "required": [
    "unitId"
  ]
}
```

searchDatasets

read

Search for datasets by name or provider

Required paramssearch

Entitiesdataset

Input schema

{
  "type": "object",
  "properties": {
    "search": {}
  },
  "additionalProperties": true,
  "required": [
    "search"
  ]
}

getCompanyInfo

read

Get information about a specific company/operator

Required paramscompanyId

Entitiescompany

Input schema

{
  "type": "object",
  "properties": {
    "companyId": {}
  },
  "additionalProperties": true,
  "required": [
    "companyId"
  ]
}

queryDatasetData

read

Query a Corva dataset directly when a dedicated helper is unavailable.

Required paramsdataset or friendlyName

Entitiesdataset

Input schema

{
  "type": "object",
  "properties": {
    "dataset": {
      "type": "string",
      "examples": [
        "wits.summary-30m"
      ],
      "description": "Dataset slug."
    },
    "friendlyName": {
      "type": "string",
      "description": "Friendly dataset name."
    },
    "query": {
      "type": "object",
      "description": "Dataset filters."
    },
    "sort": {
      "type": "object",
      "description": "Dataset sort object."
    },
    "limit": {
      "type": "number",
      "examples": [
        1000
      ],
      "description": "Maximum rows to return."
    }
  },
  "additionalProperties": true,
  "anyOf": [
    {
      "required": [
        "dataset"
      ]
    },
    {
      "required": [
        "friendlyName"
      ]
    }
  ],
  "allOf": [
    {
      "anyOf": [
        {
          "required": [
            "dataset"
          ]
        },
        {
          "required": [
            "friendlyName"
          ]
        }
      ]
    }
  ]
}

getDocuments
read
Get documentation and tutorial documents from Corva Dev Center
Entitiesdocument
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
getCurrentUserCompany
read
Get current user's company from API key (company_id, name, provider, timezone).
Entitiescompany
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
createDataset
write
Create a new dataset/collection. Auto-fetches company_id from API key.
Required paramsname
Entitiesdataset
Input schema
```
{
  "type": "object",
  "properties": {
    "name": {}
  },
  "additionalProperties": true,
  "required": [
    "name"
  ]
}
```
Optional: provider, description, dataType, schema, companyId, plottable.
createApp
write
Create a new Corva app (ui, scheduler, stream, or task)
Required paramsname
Entitiesrecord
Input schema
```
{
  "type": "object",
  "properties": {
    "name": {}
  },
  "additionalProperties": true,
  "required": [
    "name"
  ]
}
```
appType: ui|scheduler|stream|task. Flow: create→upload→status→publish.

uploadAppPackage

write

Upload a zip package. Accepts files array (auto-zips) or pre-built zipBase64.

Required paramsappId or appKey

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "appId": {},
    "appKey": {}
  },
  "additionalProperties": true,
  "allOf": [
    {
      "anyOf": [
        {
          "required": [
            "appId"
          ]
        },
        {
          "required": [
            "appKey"
          ]
        }
      ]
    }
  ]
}

files:[{path,content}] or zipBase64. Flow: create→upload→status→publish.

getAppPackageStatus

read

Poll build status. Processing: pending/queued/deploying/analyzing. Success: success/draft/published.

Required paramsappId or appKeypackageId

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "appId": {},
    "appKey": {},
    "packageId": {}
  },
  "additionalProperties": true,
  "required": [
    "packageId"
  ],
  "allOf": [
    {
      "anyOf": [
        {
          "required": [
            "appId"
          ]
        },
        {
          "required": [
            "appKey"
          ]
        }
      ]
    }
  ]
}

publishAppPackage

write

Publish a built package (draft→published). Optional label (DEV, BETA, PROD).

Required paramsappId or appKeypackageId

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "appId": {},
    "appKey": {},
    "packageId": {}
  },
  "additionalProperties": true,
  "required": [
    "packageId"
  ],
  "allOf": [
    {
      "anyOf": [
        {
          "required": [
            "appId"
          ]
        },
        {
          "required": [
            "appKey"
          ]
        }
      ]
    }
  ]
}

Optional: label (e.g., "DEV", "BETA", "PROD")

updateApp
write
Update app metadata or visibility. Use visibility: "company" to share with org.
Required paramsappId
Entitiesrecord
Input schema
```
{
  "type": "object",
  "properties": {
    "appId": {}
  },
  "additionalProperties": true,
  "required": [
    "appId"
  ]
}
```
Fields: name, description, category, segment, visibility (developer|company).
listApps
read
List apps visible to the current user with optional filtering
Entitiesrecord
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
Optional: perPage (default 25), page, visibility, includePackages (boolean)

getApp

read

Get a single app by ID or app key, includes packages and media

Required paramsappId or appKey

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "appId": {},
    "appKey": {}
  },
  "additionalProperties": true,
  "allOf": [
    {
      "anyOf": [
        {
          "required": [
            "appId"
          ]
        },
        {
          "required": [
            "appKey"
          ]
        }
      ]
    }
  ]
}

deleteAppPackage

write

Delete a specific package version from an app

Required paramsappId or appKeypackageId

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "appId": {},
    "appKey": {},
    "packageId": {}
  },
  "additionalProperties": true,
  "required": [
    "packageId"
  ],
  "allOf": [
    {
      "anyOf": [
        {
          "required": [
            "appId"
          ]
        },
        {
          "required": [
            "appKey"
          ]
        }
      ]
    }
  ]
}

deleteApp

write

Delete an entire app from the Dev Center

Required paramsappId or appKey

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "appId": {},
    "appKey": {}
  },
  "additionalProperties": true,
  "allOf": [
    {
      "anyOf": [
        {
          "required": [
            "appId"
          ]
        },
        {
          "required": [
            "appKey"
          ]
        }
      ]
    }
  ]
}

listAppPackages

read

List all package versions for an app (Corva).

Required paramsappId or appKey

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "appId": {},
    "appKey": {}
  },
  "additionalProperties": true,
  "allOf": [
    {
      "anyOf": [
        {
          "required": [
            "appId"
          ]
        },
        {
          "required": [
            "appKey"
          ]
        }
      ]
    }
  ]
}

Corva

Provenance

Freshness & coverage

Methods (42)

getWellsWithAssetIds

getDrillingWitsForPeriod

getDrillingWits

getWells

getWellDetails

getRigs

getRigById

getRigActiveWell

getWellsForRig

getPads

getPadById

getWellsForPad

getPadActiveWells

getCompletionData

getFracFleets

getFracFleetById

getFracFleetActiveWell

getWellsForFracFleet

getWirelines

getWirelineById

getWirelineActiveWell

getWellsForWireline

getDrilloutUnits

getDrilloutUnitById

getDrilloutUnitActiveWell

getWellsForDrilloutUnit

searchDatasets

getCompanyInfo

queryDatasetData

getDocuments

getCurrentUserCompany

createDataset

createApp

uploadAppPackage

getAppPackageStatus

publishAppPackage

updateApp

listApps

getApp

deleteAppPackage

deleteApp

listAppPackages