Difference between revisions of "PVT API"
From wiki.pengtools.com
| Line 6: | Line 6: | ||
All endpoints require the Authorization: Bearer <api_key> header and are subject to rate limiting. The response envelope is always { "success": <bool>, "data": <payload> } | All endpoints require the Authorization: Bearer <api_key> header and are subject to rate limiting. The response envelope is always { "success": <bool>, "data": <payload> } | ||
| − | POST /pvt-calculator/calc | + | {| class="wikitable" |
| − | + | |- | |
| − | POST /pvt-calculator/calc-async | + | ! Method !! Path !! Purpose |
| − | + | |- | |
| − | GET /pvt-calculator/{token}/status | + | | POST || /pvt-calculator/calc || Synchronous — compute and return the result in the same request |
| − | + | |- | |
| − | GET /pvt-calculator/{token}/output-data | + | | POST || /pvt-calculator/calc-async || Asynchronous — enqueue a job, return a {token} |
| − | + | |- | |
| − | GET /pvt-calculator/{token}/input-data | + | | GET || /pvt-calculator/{token}/status || Job status and progress |
| − | + | |- | |
| − | POST /pvt-calculator/{token}/start | + | | GET || /pvt-calculator/{token}/output-data || Job result (same shape as the sync data) |
| − | + | |- | |
| − | POST /pvt-calculator/{token}/stop | + | | GET || /pvt-calculator/{token}/input-data || The input the job was created with |
| − | + | |- | |
| − | DELETE /pvt-calculator/{token} | + | | POST || /pvt-calculator/{token}/start || Reset and re-run the job |
| + | |- | ||
| + | | POST || /pvt-calculator/{token}/stop || Stop a running job | ||
| + | |- | ||
| + | | DELETE || /pvt-calculator/{token} || Delete the job | ||
| + | |} | ||
[[Category:API]] | [[Category:API]] | ||
Revision as of 17:03, 14 July 2026
Contents
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> }
| Method | Path | Purpose |
|---|---|---|
| POST | /pvt-calculator/calc | Synchronous — compute and return the result in the same request |
| POST | /pvt-calculator/calc-async | Asynchronous — enqueue a job, return a {token} |
| GET | /pvt-calculator/{token}/status | Job status and progress |
| GET | /pvt-calculator/{token}/output-data | Job result (same shape as the sync data) |
| GET | /pvt-calculator/{token}/input-data | The input the job was created with |
| POST | /pvt-calculator/{token}/start | Reset and re-run the job |
| POST | /pvt-calculator/{token}/stop | Stop a running job |
| DELETE | /pvt-calculator/{token} | Delete the job |
