Difference between revisions of "PVT API"
| Line 5: | Line 5: | ||
===Endpoints=== | ===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> } | 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 - Synchronous: compute and return result in same request | ||
| + | |||
| + | POST /pvt-calculator/calc-async - Asynchronous: enqueue job, returns {token} | ||
| + | |||
| + | GET /pvt-calculator/{token}/status - Job status and progress | ||
| + | |||
| + | GET /pvt-calculator/{token}/output-data - Job result (same shape as 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 | ||
[[Category:API]] | [[Category:API]] | ||
Revision as of 17:02, 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> }
POST /pvt-calculator/calc - Synchronous: compute and return result in same request
POST /pvt-calculator/calc-async - Asynchronous: enqueue job, returns {token}
GET /pvt-calculator/{token}/status - Job status and progress
GET /pvt-calculator/{token}/output-data - Job result (same shape as 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
