💧
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
  • [1] Upload directly via the API
  • upload dbs file
  • Response description
  • [2] Uploading chemistry model files via the web UI

Was this helpful?

Uploading chemistry model files

Chemistry model files need to be uploaded to the OLI cloud so that they can be referenced in the calculation input parameters.

[1] Upload directly via the API

upload dbs file

POST https://api.olisystems.com/channel/upload/dbs

uploads the dbs file to the OLI cloud as multipart/form-data

Headers

Name
Type
Description

Authorization

string

Bearer {access_token}

{
  "file": [
    {
      "filename": "H2O-CO2.dbs", 
      "id": "fc8034d3-a6e3-4992-bc55-6c77c8d5b780"
    }
  ], 
  "status": "UPLOADED", 
  "type": "dbs"
}

Response description

field

type

description

file

array of object

information of files uploaded:

file[ ].filename

string

name of file with extension

file[ ].id

string

unique identifier for the uploaded file

status

string

"UPLOADED" or "FAILED"

type

string

type of file

[2] Uploading chemistry model files via the web UI

  1. Login to OLI Application Builder(https://appbuilder.olisystems.com) with username and password

  2. Select the username_private channel from the left pane

  3. Go to the files tab in the center pane

  4. Upload the dbs file using the "upload" button

  5. Refresh the page if required.

  6. Once uploaded, click on the file button on this pane

  7. On the right hand pane you can obtain the file id, this is used in API(s), it should look something like this: aae24777-fa3f-44a2-8f51-e56bc58f3811

PreviousChemistry WizardNextGet list of uploaded files

Last updated 1 year ago

Was this helpful?