DISPOT server API API Reference

A web version of the DISPOT tool. See the preprint https://www.biorxiv.org/content/early/2019/01/20/525535.full.pdf

API Endpoint

https://dispot.org/api

Response Content-Types: application/json, text/plain

Schemes: https

Version: 1.0.0

Paths

Compute a potential for multiple pairs of domains

GET /pairs

Run a job of computing potentials for multiple pairs of domains. One potential per pair will be computed (not cross product).

The array of pairs for which to compute the potentials.

Domains

Request Content-Types: application/json

Request Example

[
  {
    "first": "64484",
    "second": "63562"
  },
  {
    "first": "64480",
    "second": "63560"
  }
]

200 OK

Potential

OK. The computation completed.

400 Bad Request

Malformed request

default

Internal server error (500)

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "first": "64484",
    "second": "63562",
    "potential": "0.89664123"
  },
  {
    "first": "64484",
    "second": "64484",
    "potential": "1.56744111187"
  },
  {
    "first": "63562",
    "second": "63562",
    "potential": "nan"
  }
]

Schedule an auto extraction task

POST /schedule

Create an auto extraction task for given genes and schedule it. This method returns a unique identifier of the scheduled task. Use /getExecution to check the status and get the result when ready.

AutoExtraction

The two genes for which to run auto extraction task.

Request Content-Types: application/json

Request Example

{
  "geneOne": ">6FSZ:JJ|PDBID|CHAIN|SEQUENCE\nGAMSVPAIAPRRKRLADGLSVTQKVFVRSRNGGATKIVREHYLRSDIPCLSRSCTKCPQIVVPDAQNELPKFILSDSPLE\nLSAPIGKHYVVLDTNVVLQAIDLLENPNCFFDVIVPQIVLDEVRNKSYPVYTRLRTLCRDSDDHKRFIVFHNEFSEHTFV\nERLPNETINDRNNRAIRKTCQWYSEHLKPYDINVVLVTNDRLNREAATKEVESNIITKSLVQYIELLPNADDIRDSIPQM\nDSFDKDLERDTFSDFTFPEYYSTARVMGGLKNGVLYQGNIQISEYNFLEGSVSLPRFSKPVLIVGQKNLNRAFNGDQVIV\nELLPQSEWKAPSSIVLDSEHFDVNDNPDIEAGDDDDNNESSSNTTVISDKQRRLLAKDAMIAQRSKKIQPTAKVVYIQRR\nSWRQYVGQLAPSSVDPQSSSTQNVFVILMDKCLPKVRIRTRRAAELLDKRIVISIDSWPTTHKYPLGHFVRDLGTIESAQ\nAETEALLLEHDVEYRPFSKKVLECLPAEGHDWKAPTKLDDPEAVSKDPLLTKRKDLRDKLICSIDPPGCVDINDALHAKK\nLPNGNWEVGVHIADVTHFVKPGTALDAEGAARGTSVYLVDKRIDMLPMLLGTDLCSLKPYVDRFAFSVIWELDDSANIVN\nVNFMKSVIRSREAFSYEQAQLRIDDKTQNDELTMGMRALLKLSVKLKQKRLEAGALNLASPEVKVHMDSETSDPNEVEIK\nKLLATNSLVEEFMLLANISVARKIYDAFPQTAMLRRHAAPPSTNFEILNEMLNTRKNMSISLESSKALADSLDRCVDPED\nPYFNTLVRIMSTRCMMAAQYFYSGAYSYPDFRHYGLAVDIYTHFTSPIRRYCDVVAHRQLAGAIGYEPLSLTHRDKNKMD\nMICRNINRKHRNAQFAGRASIEYYVGQVMRNNESTETGYVIKVFNNGIVVLVPKFGVEGLIRLDNLTEDPNSAAFDEVEY\nKLTFVPTNSDKPRDVYVFDKVEVQVRSVMDPITSKRKAELLLK\n",
  "geneTwo": ">6FSZ:KK|PDBID|CHAIN|SEQUENCE\nMTSENPDVLLSRVINVVRAASSLASQDVDFYKNLDRGFSKDLKSKADKLADMANEIILSIDEHHESFELKEEDISDLWNN\nFGNIMDNLLEMSDHSLDKLNCAINSKSRGSDLQYLGEFSGKNFSPTKRVEKPQLKFKSPIDNSESHPFIPLLKEKPNALK\nPLSESLRLVDDDENNPSHYPHPYEYEIDHQEYSPEILQIREEIPSKSWDDSVPIWVDTSTELESMLEDLKNTKEIAVDLE\nHHDYRSYYGIVCLMQISTRERDYLVDTLKLRENLHILNEVFTNPSIVKVFHGAFMNIIWLQRDLGLYVVGLFDTYHASKA\nIGLPRHSLAYLLENFANFKTSKKYQLADWRIRPLSKPMTAYARADTHFLLNIYDQLRNKLIESNKLAGVLYESRNVAKRR\nFEYSKYRPLTPSSEVYSPIEKESPWKILMYQYNIPPEREVLVRELYQWRDLIARRDDESPRFVMPNQLLAALVAYTPTDV\nIGVVSLTNGVTEHVRQNAKLLANLIRDALRNIKNTNEEATPIPSSETKADGILLETISVPQIRDVMERFSVLCNSNISKS\nRAKPVTNSSILLGKILPREEHDIAYSKDGLPNKVKTEDIRIRAQNFKSALANLEDIIFEIEKPLVVPVKLEEIKTVDPAS\nAPNHSPEIDNLDDLVVLKKKNIQKKQPAKEKGVTEKDAVDYSKIPNILSNKPGQNNRQQKKRRFDPSSSDSNGPRAAKKR\nRPAAKGKNLSFKR\n"
}

200 OK

OK. The task has been scheduled.

400 Bad Request

Malformed request

default

Internal server error (500)

Response Content-Types: application/txt

Response Example (200 OK)

"sfjldyka"

Get the status and the result of the auto extraction execution

GET /getExecution

Query the server for a particular execution given its unique ID. Will return the status (pending, running, success or failure). If success, will return the result (raw text given by the CLI DISPOT tool). If failed, will return the error description.

slug

The unique ID (slug) of the execution, given by /schedule method.

type

object

query

200 OK

ExecutionStatus

OK.

400 Bad Request

Malformed request

404 Not Found

Execution with the given ID not found

default

Internal server error (500)

Response Content-Types: application/json

Response Example (200 OK)

{
  "slug": "sfjldyka",
  "status": "Completed",
  "result": "-0.690937888622\n6fsz:jj 88723;50249\n6fsz:kk 53098;47819\n"
}

Schema Definitions

ExecutionStatus: object

slug: string: The ID of the execution given by /schedule method
status: string , x ∈ { Pending , InProgress , Completed , Failed }: The status of the execution
result: string: If status is pending or running, the result is an empty string. If status is a success, the result is raw output of the DISPOT CLI tool. If status is a failure, the result is the error description.

Example

{
  "slug": "sfjldyka",
  "status": "Completed",
  "result": "-0.690937888622\n6fsz:jj 88723;50249\n6fsz:kk 53098;47819\n"
}

AutoExtraction: object

geneOne: string: The first gene in a pair. Must be a sequence of latin characters. It is permitted to have a header like this. ">6FSZ:JJ|PDBID|CHAIN|SEQUENCE"
geneTwo: string: The second gene in a pair. Must be a sequence of latin characters. It is permitted to have a header like this. ">6FSZ:JJ|PDBID|CHAIN|SEQUENCE"

Example

{
  "geneOne": ">6FSZ:JJ|PDBID|CHAIN|SEQUENCE\nGAMSVPAIAPRRKRLADGLSVTQKVFVRSRNGGATKIVREHYLRSDIPCLSRSCTKCPQIVVPDAQNELPKFILSDSPLE\nLSAPIGKHYVVLDTNVVLQAIDLLENPNCFFDVIVPQIVLDEVRNKSYPVYTRLRTLCRDSDDHKRFIVFHNEFSEHTFV\nERLPNETINDRNNRAIRKTCQWYSEHLKPYDINVVLVTNDRLNREAATKEVESNIITKSLVQYIELLPNADDIRDSIPQM\nDSFDKDLERDTFSDFTFPEYYSTARVMGGLKNGVLYQGNIQISEYNFLEGSVSLPRFSKPVLIVGQKNLNRAFNGDQVIV\nELLPQSEWKAPSSIVLDSEHFDVNDNPDIEAGDDDDNNESSSNTTVISDKQRRLLAKDAMIAQRSKKIQPTAKVVYIQRR\nSWRQYVGQLAPSSVDPQSSSTQNVFVILMDKCLPKVRIRTRRAAELLDKRIVISIDSWPTTHKYPLGHFVRDLGTIESAQ\nAETEALLLEHDVEYRPFSKKVLECLPAEGHDWKAPTKLDDPEAVSKDPLLTKRKDLRDKLICSIDPPGCVDINDALHAKK\nLPNGNWEVGVHIADVTHFVKPGTALDAEGAARGTSVYLVDKRIDMLPMLLGTDLCSLKPYVDRFAFSVIWELDDSANIVN\nVNFMKSVIRSREAFSYEQAQLRIDDKTQNDELTMGMRALLKLSVKLKQKRLEAGALNLASPEVKVHMDSETSDPNEVEIK\nKLLATNSLVEEFMLLANISVARKIYDAFPQTAMLRRHAAPPSTNFEILNEMLNTRKNMSISLESSKALADSLDRCVDPED\nPYFNTLVRIMSTRCMMAAQYFYSGAYSYPDFRHYGLAVDIYTHFTSPIRRYCDVVAHRQLAGAIGYEPLSLTHRDKNKMD\nMICRNINRKHRNAQFAGRASIEYYVGQVMRNNESTETGYVIKVFNNGIVVLVPKFGVEGLIRLDNLTEDPNSAAFDEVEY\nKLTFVPTNSDKPRDVYVFDKVEVQVRSVMDPITSKRKAELLLK\n",
  "geneTwo": ">6FSZ:KK|PDBID|CHAIN|SEQUENCE\nMTSENPDVLLSRVINVVRAASSLASQDVDFYKNLDRGFSKDLKSKADKLADMANEIILSIDEHHESFELKEEDISDLWNN\nFGNIMDNLLEMSDHSLDKLNCAINSKSRGSDLQYLGEFSGKNFSPTKRVEKPQLKFKSPIDNSESHPFIPLLKEKPNALK\nPLSESLRLVDDDENNPSHYPHPYEYEIDHQEYSPEILQIREEIPSKSWDDSVPIWVDTSTELESMLEDLKNTKEIAVDLE\nHHDYRSYYGIVCLMQISTRERDYLVDTLKLRENLHILNEVFTNPSIVKVFHGAFMNIIWLQRDLGLYVVGLFDTYHASKA\nIGLPRHSLAYLLENFANFKTSKKYQLADWRIRPLSKPMTAYARADTHFLLNIYDQLRNKLIESNKLAGVLYESRNVAKRR\nFEYSKYRPLTPSSEVYSPIEKESPWKILMYQYNIPPEREVLVRELYQWRDLIARRDDESPRFVMPNQLLAALVAYTPTDV\nIGVVSLTNGVTEHVRQNAKLLANLIRDALRNIKNTNEEATPIPSSETKADGILLETISVPQIRDVMERFSVLCNSNISKS\nRAKPVTNSSILLGKILPREEHDIAYSKDGLPNKVKTEDIRIRAQNFKSALANLEDIIFEIEKPLVVPVKLEEIKTVDPAS\nAPNHSPEIDNLDDLVVLKKKNIQKKQPAKEKGVTEKDAVDYSKIPNILSNKPGQNNRQQKKRRFDPSSSDSNGPRAAKKR\nRPAAKGKNLSFKR\n"
}

Potential: object

first: string: first domain ID of the pair
second: string: second domain ID of the pair
potential: string: The potential for the pair. May be a real number or "nan" for no information

Example

[
  {
    "first": "64484",
    "second": "63562",
    "potential": "0.89664123"
  },
  {
    "first": "64484",
    "second": "64484",
    "potential": "1.56744111187"
  },
  {
    "first": "63562",
    "second": "63562",
    "potential": "nan"
  }
]

Domains: object

first: string: first domain ID of the pair
second: string: second domain ID of the pair

Example

[
  {
    "first": "64484",
    "second": "63562"
  },
  {
    "first": "64480",
    "second": "63560"
  }
]

Documentation by Spectacle