API - Documentation

Here we offer an API (Application Programming Interface) to assist users in integrating piscesCSM into their research pipelines.

In summary, all jobs submitted to our server are labelled with a unique ID which is used to query the status of the job.

Job Submission https://biosig.lab.uq.edu.au/piscescsm/api/predict
POST

Arguments

  • drugA (required) - Single SMILES string for drug A
  • drugB (required) - Single SMILES string for drug B

Return

  • job_id - ID used for uniquely identify each job

Examples

  • curl

    $ curl https://biosig.lab.uq.edu.au/piscescsm/api/predict -X POST -i -F drugA="CC(=O)C(=O)O" -F drugB="C1=CN=CC=C1C(=O)NN" 
    
HTTP/1.1 200 OK
Date: Mon, 17 Oct 2022 00:17:40 GMT
Content-Type: application/json
Content-Length: 31
Connection: keep-alive

{"job_id": "api_166596586018"}
GET - Retrieve Job Results

Arguments

  • job_id - ID used for uniquely identify each job. Generated upon submission

Return

For jobs still being processed or waiting on queue, the message below will be returned from querying this endpoint:
  • message - running
For jobs successfully processed by piscesCSM, the following data will be returned:
  • prediction -

Examples

  • curl

    $ curl https://biosig.lab.uq.edu.au/piscescsm/api/predict -X GET -F job_id=15917658595 
    
{
	"melanoma_prediction": "antagonistic", 
	"breast_prediction": "synergistic", 
	"lung_prediction": "synergistic", 
	"general_prediction": "synergistic", 
	"prostate_prediction": "antagonistic", 
	"colon_prediction": "synergistic", 
	"ovarian_prediction": "synergistic"
	"drugB": {
		"num_hacc": 2.0, 
		"smiles": "C1=CN=CC=C1C(=O)NN", 
		"mw": 137.142, 
		"logp": -0.3149, 
		"num_rings": 1.0, 
		"num_atoms": 10.0, 
		"num_hdon": 2.0, 
		"num_rotbonds": 1.0
	}, 
	"drugA": {
		"num_hacc": 3.0, 
		"smiles": "CC(=O)C(=O)O", 
		"mw": 88.06200000000001, 
		"logp": -0.34, 
		"num_rings": 0.0, 
		"num_atoms": 6.0, 
		"num_hdon": 1.0, 
		"num_rotbonds": 1.0
	}, 
}