Difference between revisions of "PVT API"

Revision as of 17:16, 14 July 2026

PVT API

The PVT calculator models reservoir fluid properties (oil, gas, water) over a pressure range using various correlations, and returns property curves (plots), single‑point reservoir‑condition values (solution), and a stepped property table (results).

Endpoints

All endpoints require the Authorization: Bearer <api_key> header and are subject to rate limiting. The response envelope is always { "success": <bool>, "data": <payload> }

Use /calc (synchronous) for normal interactive requests — a single PVT model computes in well under a second and the result comes back in the HTTP response.

Use /calc-async only for batch/heavy workloads where you would rather not hold an open HTTP connection. The async path enqueues an api_task row that is picked up by the CalcDaemon worker; you then poll status and fetch output-data. The async job runs the same calculatePvt() code as the sync endpoint, so the result is identical for identical input.

Synchronous request

POST /pvt-calculator/calc

The request body is a JSON object containing PVT calculator attributes plus two optional unit-control keys:

{
 "unit_system": "RU",
 "defaultFluidType": "OIL",
 "maximumPressure": 300,
 "reservoirPressure": 300,
 "temperature": 90,
 "pBubbleInitial": 200,
 "rsbInitial": 60,
 "isRsbUsedForPb": true,
 "sgOil": 0.85,
 "sgGas": 0.75,
 "sgWater": 1.0
}

On success the endpoint returns HTTP 200 with:

{
 "success": true,
 "data": {
   "plots": {},
   "solution": {},
   "results": {}
 }
}

Where data carries:

• plots — property curves
• solution — single-point reservoir-condition values
• results — stepped property table

Units

Input field names (e.g., maximumPressure, temperature) carry no unit. The unit system determines how values are interpreted.

unit_system

Accepted values:

• METRIC - Metric system
• FIELD - US field system

Example: {

 "unit_system": "METRIC",
 "maximumPressure": 300,
 "temperature": 90

}

userUnits

Override specific fields. Merged on top of unit_system.

Example: {

 "unit_system": "METRIC",
 "userUnits": {
   "temperature": "FAHRENHEIT"
 },
 "maximumPressure": 300,
 "temperature": 90

}

Per-attribute units