Main methods

This page summarizes all the methods supported by the OLI ScaleChem API and explains the basic input schema.

Run scalechem calculation

POST https://api.olisystems.com/engine/scalechem/{fileId}

Headers

Name	Type	Description
Authorization*	String	Bearer {access_token}
Content-Type	String	application/json

200: OK Please look at "API call blueprint" page

{
	"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

{
    "method": "scalechem.brineAnalysis",
    "params": {
        "chemistryModel": "chem",
        ...<snip>...
        }
}

Methods

method	description
"scalechem.brineAnalysis"	Brine analysis
"scalechem.oilAnalysis"	Oil analysis
"scalechem.gasAnalysis"	Gas analysis
"scalechem.mixerCalculation"	Mixer calculation
"scalechem.scaleScenario"	Calculate scaling scenario

Chemistry model

params.chemistryModel specifies the name of the chemistry model file with ".dbs" extension, that is uploaded in the package.