💧
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
  • Request payload
  • Response (status = PROCESSED)
  • Survey Calculation

Was this helpful?

  1. OLI ScaleChem API
  2. Main methods

Oil analysis

Request payload

{
    "method": "scalechem.oilAnalysis",
    "params": {
        "chemistryModel": "chem",
        "temperature": {
            "value": 30.0,
            "unit": "°C"
        },
        "pressure": {
            "value": 2.0,
            "unit": "atm"
        },
        "inflows": {
            "unit": "mole %",
            "values": {
                "H2O": 10.0,
                "CO2": 10.0,
                "CH4": 40.0,
                "C4H10": 20.0
            }
        },
        "saturateWithH2O": true
    }
}

param

type

description

chemistryModel

string

temperature

pressure

inflows

object

saturateWithH2O

boolean

option to add H2O to saturate the organic liquid phase.

params.saturateWithH2O input is optional. By default, it's set to false.

Response (status = PROCESSED)

Survey Calculation

supported params.surveyInputs[{}].field

"/params/temperature/value"

"/params/pressure/value"

"/params/inflows/values/<InflowName>"

PreviousGas analysisNextMixer calculation

Last updated 1 year ago

Was this helpful?

specified temperature with

specified 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 at .

The output of this calculation is the which is common result output for all OLI's flash calculations or an .

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

Optional Inputs
stream output
error
Survey calculation
unit
unit
Inflows Input
chemistry model name
valueObject
valueObject