solvx_reservoir_tools

{ "openapi": "3.1.0", "info": { "title": "Calculate All PVT Properties", "description": "API service for calculating petroleum fluid PVT properties using various correlations", "version": "1.0.0" }, "paths": { "/api/correlations-collection": { "get": { "summary": "Get Available Correlations", "description": "Get a list of all available correlations for oil, gas, and water properties.\nThis endpoint does not require authentication.", "operationId": "get_available_correlations_api_correlations_collection_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } } } } }, "/api": { "get": { "summary": "Read Root", "operationId": "read_root_api_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } } } } }, "/api/pvt/calculateallproperties": { "post": { "summary": "Calculate Pvt Properties", "description": "Calculate all PVT properties for oil, gas, and water phases.\nEither gas_oil_ratio or bubble_point_pressure must be provided (or both).\nIf only one is provided, the other will be calculated using the specified correlations.", "operationId": "calculate_pvt_properties_api_pvt_calculateallproperties_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_pvt_properties_api_pvt_calculateallproperties_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculatepbfromgor": { "post": { "summary": "Calculate Pb From Gor Api", "description": "Calculate bubble point pressure (Pb) from gas-oil ratio (GOR) using the specified correlation.", "operationId": "calculate_pb_from_gor_api_api_pvt_calculatepbfromgor_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_pb_from_gor_api_api_pvt_calculatepbfromgor_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculategorfrompb": { "post": { "summary": "Calculate Gor From Pb Api", "description": "Calculate gas-oil ratio (GOR) from bubble point pressure (Pb) using the specified correlation.", "operationId": "calculate_gor_from_pb_api_api_pvt_calculategorfrompb_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_gor_from_pb_api_api_pvt_calculategorfrompb_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculatepseudopressure": { "post": { "summary": "Calculate Pseudopressure Api", "description": "Calculate pseudopressure using the trapezoid method.", "operationId": "calculate_pseudopressure_api_api_pvt_calculatepseudopressure_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_pseudopressure_api_api_pvt_calculatepseudopressure_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculateoilproperties": { "post": { "summary": "Calculate Oil Properties Api", "description": "Calculate oil properties using the specified correlations.\nEither gas_oil_ratio or bubble_point_pressure must be provided (or both).\nIf only one is provided, the other will be calculated.", "operationId": "calculate_oil_properties_api_api_pvt_calculateoilproperties_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_oil_properties_api_api_pvt_calculateoilproperties_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculategasproperties": { "post": { "summary": "Calculate Gas Properties Api", "description": "Calculate gas properties using the specified correlations.", "operationId": "calculate_gas_properties_api_api_pvt_calculategasproperties_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_gas_properties_api_api_pvt_calculategasproperties_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculatewaterproperties": { "post": { "summary": "Calculate Water Properties Api", "description": "Calculate water properties using the specified correlations.", "operationId": "calculate_water_properties_api_api_pvt_calculatewaterproperties_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_water_properties_api_api_pvt_calculatewaterproperties_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/compressibility/davidyale": { "post": { "summary": "Calculate Compressibility David Yale Api", "description": "Calculate rock compressibility using the David Yale method.", "operationId": "calculate_compressibility_david_yale_api_api_pvt_compressibility_davidyale_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_compressibility_david_yale_api_api_pvt_compressibility_davidyale_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/compressibility/mccain": { "post": { "summary": "Calculate Compressibility Mccain Api", "description": "Calculate compressibility using the McCain method.", "operationId": "calculate_compressibility_mccain_api_api_pvt_compressibility_mccain_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_compressibility_mccain_api_api_pvt_compressibility_mccain_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/interfacialtension/ramey": { "post": { "summary": "Calculate Ift Ramey Api", "description": "Calculate interfacial tension between oil and gas using Ramey's correlation.", "operationId": "calculate_ift_ramey_api_api_pvt_interfacialtension_ramey_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_ift_ramey_api_api_pvt_interfacialtension_ramey_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/interfacialtension/asheim": { "post": { "summary": "Calculate Ift Asheim Api", "description": "Calculate interfacial tension between oil and gas using Asheim's correlation.", "operationId": "calculate_ift_asheim_api_api_pvt_interfacialtension_asheim_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_ift_asheim_api_api_pvt_interfacialtension_asheim_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/interfacialtension/bakerswerdloff": { "post": { "summary": "Calculate Ift Baker Swerdloff Api", "description": "Calculate interfacial tension between oil and gas using Baker-Swerdloff correlation.", "operationId": "calculate_ift_baker_swerdloff_api_api_pvt_interfacialtension_bakerswerdloff_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_ift_baker_swerdloff_api_api_pvt_interfacialtension_bakerswerdloff_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/interfacialtension/oilwater": { "post": { "summary": "Calculate Ift Oil Water Api", "description": "Calculate interfacial tension between oil and water.", "operationId": "calculate_ift_oil_water_api_api_pvt_interfacialtension_oilwater_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_ift_oil_water_api_api_pvt_interfacialtension_oilwater_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/interfacialtension/gaswater": { "post": { "summary": "Calculate Ift Gas Water Api", "description": "Calculate interfacial tension between gas and water.", "operationId": "calculate_ift_gas_water_api_api_pvt_interfacialtension_gaswater_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_ift_gas_water_api_api_pvt_interfacialtension_gaswater_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculaters": { "post": { "summary": "Calculate Rs Api", "description": "Calculate solution gas-oil ratio (Rs) at given pressure using selected correlation.\n\nArgs:\n correlation: Correlation to use (STANDING, VAZQUEZBEGGS, GLASO, LASATER)\n temperature: Reservoir temperature in °F\n pressure: Pressure in psia\n api: Oil API gravity\n gas_gravity: Gas specific gravity (relative to air)\n pb: Bubble point pressure in psia\n \nReturns:\n Dictionary containing:\n - rs: Solution gas-oil ratio in scf/STB\n - units: Units of measurement\n - correlation: Correlation used for calculation", "operationId": "calculate_rs_api_api_pvt_calculaters_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_rs_api_api_pvt_calculaters_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculateoilfvf": { "post": { "summary": "Calculate Oil Fvf Api", "description": "Calculate oil formation volume factor (Bo) using selected correlation.\n\nEither pb (bubble point pressure) or initial_gor must be provided, but not necessarily both.\nIf both are provided, the bubble point pressure (pb) will be honored and initial_gor will be recalculated.", "operationId": "calculate_oil_fvf_api_api_pvt_calculateoilfvf_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_oil_fvf_api_api_pvt_calculateoilfvf_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculatedeadoilvisc": { "post": { "summary": "Calculate Dead Oil Visc Api", "description": "Calculate dead oil viscosity using selected correlation.", "operationId": "calculate_dead_oil_visc_api_api_pvt_calculatedeadoilvisc_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_dead_oil_visc_api_api_pvt_calculatedeadoilvisc_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculatesaturatedoilvisc": { "post": { "summary": "Calculate Saturated Oil Visc Api", "description": "Calculate saturated oil viscosity using selected correlation.", "operationId": "calculate_saturated_oil_visc_api_api_pvt_calculatesaturatedoilvisc_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_saturated_oil_visc_api_api_pvt_calculatesaturatedoilvisc_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculateundersaturatedoilvisc": { "post": { "summary": "Calculate Undersaturated Oil Visc Api", "description": "Calculate undersaturated oil viscosity using selected correlation.", "operationId": "calculate_undersaturated_oil_visc_api_api_pvt_calculateundersaturatedoilvisc_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_undersaturated_oil_visc_api_api_pvt_calculateundersaturatedoilvisc_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculateoilviscosity": { "post": { "summary": "Calculate Oil Viscosity Api", "description": "Calculate oil viscosity using selected correlations.\n\nEither pb (bubble point pressure) or rs (solution gas-oil ratio) must be provided, but not necessarily both.\nIf both are provided, the bubble point pressure (pb) will be honored and rs will be recalculated.", "operationId": "calculate_oil_viscosity_api_api_pvt_calculateoilviscosity_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_oil_viscosity_api_api_pvt_calculateoilviscosity_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculateoilcompressibility": { "post": { "summary": "Calculate Oil Compressibility Api", "description": "Calculate oil compressibility (Co) using selected correlation.\n\nEither pb (bubble point pressure) or gor must be provided, but not necessarily both.\nIf both are provided, the bubble point pressure (pb) will be honored and gor will be recalculated.", "operationId": "calculate_oil_compressibility_api_api_pvt_calculateoilcompressibility_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_oil_compressibility_api_api_pvt_calculateoilcompressibility_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculatezfactor": { "post": { "summary": "Calculate Z Factor Api", "description": "Calculate gas z-factor using selected correlation.", "operationId": "calculate_z_factor_api_api_pvt_calculatezfactor_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_z_factor_api_api_pvt_calculatezfactor_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculategasfvf": { "post": { "summary": "Calculate Gas Fvf Api", "description": "Calculate gas formation volume factor (Bg) using selected correlation.", "operationId": "calculate_gas_fvf_api_api_pvt_calculategasfvf_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_gas_fvf_api_api_pvt_calculategasfvf_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculategascompressibility": { "post": { "summary": "Calculate Gas Compressibility Api", "description": "Calculate gas compressibility (Cg) using selected correlation.", "operationId": "calculate_gas_compressibility_api_api_pvt_calculategascompressibility_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_gas_compressibility_api_api_pvt_calculategascompressibility_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculategasviscosity": { "post": { "summary": "Calculate Gas Viscosity Api", "description": "Calculate gas viscosity (μg) using selected correlation.", "operationId": "calculate_gas_viscosity_api_api_pvt_calculategasviscosity_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_gas_viscosity_api_api_pvt_calculategasviscosity_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculategasdensity": { "post": { "summary": "Calculate Gas Density Api", "description": "Calculate gas density (ρg) using the real gas law.", "operationId": "calculate_gas_density_api_api_pvt_calculategasdensity_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_gas_density_api_api_pvt_calculategasdensity_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculatewaterviscosity": { "post": { "summary": "Calculate Water Viscosity Api", "description": "Calculate water viscosity using selected correlation.", "operationId": "calculate_water_viscosity_api_api_pvt_calculatewaterviscosity_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_water_viscosity_api_api_pvt_calculatewaterviscosity_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculatewatercompressibility": { "post": { "summary": "Calculate Water Compressibility Api", "description": "Calculate water compressibility using selected correlation.", "operationId": "calculate_water_compressibility_api_api_pvt_calculatewatercompressibility_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_water_compressibility_api_api_pvt_calculatewatercompressibility_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculatewaterfvf": { "post": { "summary": "Calculate Water Fvf Api", "description": "Calculate water formation volume factor using selected correlation.", "operationId": "calculate_water_fvf_api_api_pvt_calculatewaterfvf_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_water_fvf_api_api_pvt_calculatewaterfvf_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/pvt/calculategassolubilityinwater": { "post": { "summary": "Calculate Gas Solubility In Water Api", "description": "Calculate gas solubility in water (Rsw) using selected correlation.", "operationId": "calculate_gas_solubility_in_water_api_api_pvt_calculategassolubilityinwater_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_calculate_gas_solubility_in_water_api_api_pvt_calculategassolubilityinwater_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/bhp/BHPcalculator": { "post": { "summary": "Calculate Bhp", "description": "Calculate Bottom Hole Pressure (BHP) using the specified multiphase flow correlation.", "operationId": "calculate_bhp_api_bhp_BHPcalculator_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BHPRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/logs/{api_key}": { "get": { "summary": "Get Api Logs", "description": "Retrieves API request logs for the tenant associated with the provided API key.\nReturns the last 100 log entries by default.", "operationId": "get_api_logs_api_logs__api_key__get", "parameters": [ { "name": "api_key", "in": "path", "required": true, "schema": { "type": "string", "title": "Api Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response Get Api Logs Api Logs Api Key Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/rta/calculatesuperpositiontime": { "post": { "summary": "Calculate Superposition Time Api", "description": "Calculate superposition time for multiple phase rates using specified flow regime.\n\nParameters:\n- time: Array of time values\n- phase_rates: Dictionary containing rate arrays for different phases (e.g., {\"oil\": [...], \"gas\": [...], \"water\": [...]})\n- flow_regime: Flow regime type ('linear', 'bilinear', 'pss', or 'radial')\n\nReturns:\nDictionary containing superposition time arrays for each phase", "operationId": "calculate_superposition_time_api_api_rta_calculatesuperpositiontime_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuperpositionTimeRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/rta/calculatederivatives": { "post": { "summary": "Calculate Derivatives Api", "description": "Calculate derivatives for multiple phase rates using specified flow regime.\n\nParameters:\n- time: Array of time values\n- phase_rates: Dictionary containing rate arrays for different phases (e.g., {\"oil\": [...], \"gas\": [...], \"water\": [...]})\n- pressure: Array of pressure values (common for all phases)\n- flow_regime: Flow regime type ('linear', 'bilinear', 'pss', or 'radial')\n- p_initial: Initial reservoir pressure\n- fluid_p: List of fluid properties [Temp, Specific_Gravity, API, GOR, MoleFraction_H2S, MoleFraction_CO2, MoleFraction_N2, MoleFraction_H2O]\n- s_ratio: Superposition time ratio for derivative calculation\n\nReturns:\nDictionary containing derivative arrays for each phase", "operationId": "calculate_derivatives_api_api_rta_calculatederivatives_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DerivativesRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/rta/calculatesinglephasesuper": { "post": { "summary": "Calculate Single Phase Superposition Time Api", "description": "Calculate superposition time for a single phase using specified flow regime.\n\nParameters:\n- time: Array of time values\n- rate: Array of rates for a single phase\n- flow_regime: Flow regime type ('linear', 'bilinear', 'pss', or 'radial')\n- phase_name: Optional name for the phase\n\nReturns:\nArray of superposition time values", "operationId": "calculate_single_phase_superposition_time_api_api_rta_calculatesinglephasesuper_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SinglePhaseSuperpositionTimeRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/api/rta/calculatesinglephaseders": { "post": { "summary": "Calculate Single Phase Derivatives Api", "description": "Calculate derivatives for a single phase using specified flow regime.\n\nParameters:\n- time: Array of time values\n- rate: Array of rates for a single phase\n- pressure: Array of pressure values\n- flow_regime: Flow regime type ('linear', 'bilinear', 'pss', or 'radial')\n- is_gas: True if gas phase, False if oil phase\n- p_initial: Initial reservoir pressure\n- fluid_p: List of fluid properties [Temp, Specific_Gravity, API, GOR, MoleFraction_H2S, MoleFraction_CO2, MoleFraction_N2, MoleFraction_H2O]\n- s_ratio: Superposition time ratio for derivative calculation\n- phase_name: Optional name for the phase\n\nReturns:\nArray of derivative values", "operationId": "calculate_single_phase_derivatives_api_api_rta_calculatesinglephaseders_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SinglePhaseDerivativesRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": {