API Documentation:

epitope3D is also available through an API (Application Programming Interface), which can be a usefull tool for other research applications aiming to access our prediction resources.

The submission is processed by our server in a queue and receive an unique identifier called Job ID. Using this ID you will be able to check the status and receive the result when ready. You can send the pdb file or inform the pdb accession code to epitope3D via API and get the results.
Here we present how to use it:

POST - Job Submission

  • URL: http://biosig.unimelb.edu.au/epitope3d/api/submission

  • Arguments

    • pdb_accession (required) - 4 character PDB code; OR
    • pdb_file file in PDB format
    • email (optional) - Email for contact when the job is finished or if an error occurs.

    Return

    • job_id - ID used for uniquely identify each job

    Example

    • curl

      $ curl http://biosig.unimelb.edu.au/epitope3d/api/submission -X POST -i -F pdb_accession='2p5p' -F email=xxxx@gmail.com

      HTTP/1.0 200 OK
      Content-Type: application/json
      Content-Length: 34
      Date: Tue, 27 Apr 2021 18:22:15 GMT
      {
      "job_id": "1619547734.93"
      }


      GET - Retrieve Job Result

      Arguments


      • job_id - ID used for uniquely identify each job

      Return


      If your job is still being processed, the following message will appear:

      • message - RUNNING

      For jobs successfully completed, the following data will be returned:

      • prediction -

      Example


      • curl

        $ curl http://biosig.unimelb.edu.au/epitope3d/api/submission -X GET -F job_id=1619547734.93

        {
        "300_THR_A": {
        "prediction": "non-epitope",
        "score": 0.24
        },
        "301_THR_A": {
        "prediction": "non-epitope",
        "score": 0.217
        },
        "302_TYR_A": {
        "prediction": "non-epitope",
        "score": 0.297
        },
        "303_GLY_A": {
        "prediction": "non-epitope",
        "score": 0.28
        },
        "304_VAL_A": {
        "prediction": "non-epitope",
        "score": 0.16
        },
        "327_LEU_A": {
        "prediction": "epitope",
        "score": 0.753
        ...
        }