API - Documentation

Here we offer an API (Application Programming Interface) to assist users in integrating CSM-peptides 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 - Single Peptide sequence https://biosig.lab.uq.edu.au/csm_peptides/api/predict
POST

Arguments

  • pep_str (required) - Single Peptide sequence
  • email (optional) - Email for contact when the job is finished

Return

  • job_id - ID used for uniquely identify each job

Examples

  • curl

    $ curl https://biosig.lab.uq.edu.au/csm_peptides/api/predict -X POST -i -F pep_str="GAWKNFWSSLRKGFYDGEAGRAIRR" 
    
{
    "job_id": "163287605188"
}
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 CSM-peptides, the following data will be returned:
  • prediction -

Examples

  • curl

    $ curl https://biosig.lab.uq.edu.au/csm_peptides/api/predict -X GET -F job_id=15917658595 
    
{
    "GAWKNFWSSLRKGFYDGEAGRAIRR": {
        "csm_peptide_AAP": "Positive (0.6)", 
        "csm_peptide_ABP": "Negative (0.34)", 
        "csm_peptide_ACP": "Positive (0.89)", 
        "csm_peptide_AIP": "Negative (0.11)", 
        "csm_peptide_AVP": "Negative (0.45)", 
        "csm_peptide_CPP": "Positive (0.99)", 
        "csm_peptide_QSP": "Negative (0.06)", 
        "csm_peptide_SBP": "Positive (0.61)"
    }
}
Job Submission - List of Peptides https://biosig.lab.uq.edu.au/csm_peptides/api/predict
POST

Arguments

  • pep_list (required) - List of peptides in fasta format
  • email (optional) - Email for contact when the job is finished

Return

  • job_id - ID used for uniquely identify each job

Examples

  • curl

    $ curl https://biosig.lab.uq.edu.au/csm_peptides/api/predict -X POST -i -F pep_list=@/home/ubuntu/pep_list.fasta 
    
{
    "job_id": "163287883429"
}
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 CSM-peptides, the following data will be returned:
  • Array list of results (in json format) for small molecule

Examples

  • curl

    $ curl https://biosig.lab.uq.edu.au/csm_peptides/api/predict -X GET -F job_id=163287883429 
    
{
    "ALWKTIIKGAGKMIGSLAKNLLGSQAQPES": {
        "csm_peptide_AAP": "Positive (0.67)", 
        "csm_peptide_ABP": "Negative (0.35)", 
        "csm_peptide_ACP": "Positive (0.98)", 
        "csm_peptide_AIP": "Negative (0.22)", 
        "csm_peptide_AVP": "Negative (0.42)", 
        "csm_peptide_CPP": "Positive (0.92)", 
        "csm_peptide_QSP": "Positive (1.0)", 
        "csm_peptide_SBP": "Positive (0.63)"
    }, 
    "EPNPNEFFGLM": {
        "csm_peptide_AAP": "Negative (0.43)", 
        "csm_peptide_ABP": "Negative (0.3)", 
        "csm_peptide_ACP": "Negative (0.5)", 
        "csm_peptide_AIP": "Negative (0.2)", 
        "csm_peptide_AVP": "Positive (0.56)", 
        "csm_peptide_CPP": "Positive (0.97)", 
        "csm_peptide_QSP": "Negative (0.22)", 
        "csm_peptide_SBP": "Positive (0.68)"
    }, 
    "GAWKNFWSSLRKGFYDGEAGRAIRR": {
        "csm_peptide_AAP": "Positive (0.6)", 
        "csm_peptide_ABP": "Negative (0.34)", 
        "csm_peptide_ACP": "Positive (0.89)", 
        "csm_peptide_AIP": "Negative (0.11)", 
        "csm_peptide_AVP": "Negative (0.45)", 
        "csm_peptide_CPP": "Positive (0.99)", 
        "csm_peptide_QSP": "Negative (0.06)", 
        "csm_peptide_SBP": "Positive (0.61)"
    }, 
    "GILDTIKNAAKTVAVGLLEKIKCKMTGC": {
        "csm_peptide_AAP": "Positive (0.6)", 
        "csm_peptide_ABP": "Negative (0.18)", 
        "csm_peptide_ACP": "Positive (0.69)", 
        "csm_peptide_AIP": "Positive (0.54)", 
        "csm_peptide_AVP": "Negative (0.41)", 
        "csm_peptide_CPP": "Positive (0.92)", 
        "csm_peptide_QSP": "Positive (1.0)", 
        "csm_peptide_SBP": "Positive (0.72)"
    }, 
    "GWKKWLRKGAKHLGQAAIK": {
        "csm_peptide_AAP": "Positive (0.52)", 
        "csm_peptide_ABP": "Negative (0.32)", 
        "csm_peptide_ACP": "Positive (0.53)", 
        "csm_peptide_AIP": "Negative (0.33)", 
        "csm_peptide_AVP": "Negative (0.4)", 
        "csm_peptide_CPP": "Positive (0.88)", 
        "csm_peptide_QSP": "Negative (0.15)", 
        "csm_peptide_SBP": "Positive (0.56)"
    }, 
    "MFFSSKKCKTVSKTFRGPCVRNAN": {
        "csm_peptide_AAP": "Negative (0.44)", 
        "csm_peptide_ABP": "Negative (0.39)", 
        "csm_peptide_ACP": "Positive (0.57)", 
        "csm_peptide_AIP": "Positive (0.62)", 
        "csm_peptide_AVP": "Negative (0.48)", 
        "csm_peptide_CPP": "Positive (0.86)", 
        "csm_peptide_QSP": "Positive (0.84)", 
        "csm_peptide_SBP": "Positive (0.63)"
    }, 
    "RFRPPIRRPPIRPPFRPPFRPPVRPPIRPPFRPPFRPPIGPFP": {
        "csm_peptide_AAP": "Negative (0.19)", 
        "csm_peptide_ABP": "Negative (0.33)", 
        "csm_peptide_ACP": "Positive (0.62)", 
        "csm_peptide_AIP": "Negative (0.02)", 
        "csm_peptide_AVP": "Negative (0.42)", 
        "csm_peptide_CPP": "Positive (0.88)", 
        "csm_peptide_QSP": "Positive (1.0)", 
        "csm_peptide_SBP": "Positive (0.67)"
    }, 
}