💧
OLI API
  • Welcome to the OLI API documentation
  • Basic workflow
  • Authentication
    • Bearer Token
    • API Keys
      • Generate a Key
      • List All Keys
      • Delete a Key
  • Generating chemistry model files
    • ChemBuilder API
      • Getting Started with ChemBuilder
        • Set Thermodynamic Framework
        • Include Private Databanks
        • Include Inflows
          • Include Assays
          • Include Pseudocomponent
        • Choose Phases
        • Specify Model Name
        • Choose Redox
        • Choose Solids
        • Add Kinetics
      • ChemBuilder Query
        • Species Query
        • Redox Query
        • Solid Phase Query
        • Databank Query
        • Kinetics Query
        • Query Output Results
      • Supporting Information for ChemBuilder
        • Add Comment
        • "enabled" Keyword
        • ChemBuilder Errors
    • Chemistry Wizard
  • Uploading chemistry model files
  • Get list of uploaded files
  • Quickstart example: Python
  • Known issues and Limitations
  • OLI ENGINE API
    • Main methods
      • API call blueprint
      • Chemistry information
      • Isothermal flash
      • Isenthalpic flash
      • Bubble point flash
      • Dew point flash
      • Vapor amount flash
      • Vapor fraction flash
      • Isochoric flash
      • set pH flash
      • Precipitation point flash
      • Autoclave
      • Custom flash
      • Corrosion contact surfaces
      • Corrosion rates
      • Water analysis
  • Additional methods
    • Flash history - Chemistry model
    • Result - by jobId
    • delete file
    • cancel run
  • Inflows input
  • Optional inputs
  • Kinetic calculation inputs
  • Kinetic calculation outputs
  • Input units
  • User defined output unit set
  • Survey calculation
  • Stream output
  • Error/Warning output
  • Definition of terms
  • OLI Process API
    • Uploading a Process API package
      • Creating a Process API package
    • Get list of all uploaded ProcessAPI packages
    • Get input specs for Process API package
    • Get output specs for ProcessAPI package
    • Run a Process API calculation
    • Get calculation status and results
  • Deleting a process package
  • Undelete a process package
  • Process API input specification
    • "data" object
      • "flowsheet" object
        • "chemical-info" object
        • "general-info" object
        • "properties" object
        • "units_set_info" object
  • OLI ScaleChem API
    • Uploading chemistry model files for ScaleChem API
    • Get list of uploaded ScaleChem model files
    • Main methods
      • Brine analysis
      • Gas analysis
      • Oil analysis
      • Mixer calculation
      • Scale scenario
Powered by GitBook
On this page
  • dew point
  • Request payload
  • Response (status = PROCESSED)
  • Survey Calculation

Was this helpful?

  1. OLI ENGINE API
  2. Main methods

Dew point flash

This function calculates mixture dew point temperature or pressure depending on the input option.

dew point

POST https://api.olisystems.com/engine/flash/{dbs_file_id}/dewpoint

run a dewpoint temperature or pressure calculation

Headers

Name
Type
Description

Authorization

string

Bearer {access_token}

Content-Type

string

application/json

{
	"code": 200,
	"data": {
		"file_id": "dee854a6-59db-487d-ad08-a20dee691133",
		"jobId": "f6b3375e-cd0f-4ace-a5ee-71e047b76754",
		"resultsLink": "https://devapi.olisystems.com/result/flash/f6b3375e-cd0f-4ace-a5ee-71e047b76754?context=engine",
		"status": "IN PROGRESS"
	},
	"message": "Process execution started Successfully",
	"status": "SUCCESS"
}

Request payload

{
    "params": {
        "temperature": {
            "value": 30.0,
            "unit": "°C"
        },
        "pressure": {
            "value": 1.5,
            "unit": "atm"
        },
        "calculatedVariable": "pressure",
        "inflows": {
            "unit": "mol",
            "values": {
                "H2O": 50.0,
                "CO2": 10.0,
                "NACL": 20.0,
                "BENZENE": 10.0
            }
        }
    }
}

params

type

description

temperature

pressure

calculatedVariable

string

variable to be calculated, i.e. "temperature" or "pressure"

inflows

object

Response (status = PROCESSED)

{
    "code": 200,
    "data": {
        "result": {
           "calculatedVariables": [
                {
                    "name": "temperature",
                    "unit": "°C",
                    "value": 110.74053319131087
                }
            ],
            ...<snip>...
        }
    },
    "message": "Results returned successfully", 
    "status": "PROCESSED"
}
{
    "code": 200,
    "data": {
        "result": {
           "calculatedVariables": [
                {
                    "name": "pressure",
                    "unit": "atm",
                    "value": 0.044180122983096495
                }
            ],
            ...<snip>...
        }
    },
    "message": "Results returned successfully", 
    "status": "PROCESSED"
}

type

description

name

string

name of the calculated variable, i.e. temperature or pressure as specified in JSON input params.calculatedVariable

value

number

value of the calculated variable

unit

string

unit of the calculated variable, which is the same as specified in the input initial guess, i.e. params.temperature.unit/params.pressure.unit in input

Survey Calculation

supported params.surveyInputs[{}].field

"/params/temperature/value"

"/params/pressure/value"

PreviousBubble point flashNextVapor amount flash

Last updated 3 years ago

Was this helpful?

specified or initial guess temperature with

specified or initial guess pressure with

specified inflow species composition, see

in addition to the inputs shown above some optional properties may also be specified. They can be viewed

If kinetic reactions are defined in the chemistry model, kinetic calculation inputs are required to be specified. A detailed description can be found .

The output of this calculation is the which is common result output for all OLI's flash calculations or an . In addition to this output the result also contains the solution temperature/pressure which can be conveniently retrieved from the data.result.calculatedVariables array

data.result.calculatedVariables

Survey calculation is supported for the variables below. Please refer to for explained input schema.

here
here
stream output
error
Survey calculation
valueObject
unit
valueObject
unit
Inflows Input
[ { } ]