Property prediction · Sequence analysis

DeepImmuno API

Score how likely a peptide-MHC class I pair is to provoke a CD8 T-cell response.

Runs the DeepImmuno convolutional model over 9- or 10-mer epitopes paired with an HLA class I allele, returning an immunogenicity score per pair. Binding prediction is a separate question: this scores whether a presented peptide is recognised, not whether it is presented.

Web form Home page ↗ Source code ↗

Submit POST /api/deepimmuno/

Queues a run and returns 202 with the job.

Schema GET /api/deepimmuno/

Returns this tool's metadata and the fields below, as JSON.

Tasks

Pick a mode with `task`

Fields belonging to another task are ignored, so send only the ones for the task you chose.

task	Mode
`single` default	One epitope
`batch`	Many epitopes

Request body

Fields

The same names the web form posts. See the field type table for what each kind means over HTTP.

Name	Type	Required	Default	Description
`job_name`	string text	no	`deepimmuno-demo`	Job name
`epitope` single	string text	yes	`AAGIGILTV`	Epitope A 9-mer or 10-mer peptide. up to 10 characters.
`hla` single	string text	yes	`HLA-A*0201`	HLA allele up to 20 characters.
`pairs` batch	string textarea	yes	`AAGIGILTV,HLA-A0201 SLYNTVATL,HLA-A0201 GILGFVFTL,HLA-A*0201`	Epitope and allele pairs One pair per line, as epitope,allele.

Example

A request that runs

These are the defaults, exactly as the web form would post them.

curl -X POST https://www.athanortools.com/api/deepimmuno/ \
  -H 'Content-Type: application/json' \
  -d '{
  "task": "single",
  "job_name": "deepimmuno-demo",
  "epitope": "AAGIGILTV",
  "hla": "HLA-A*0201"
}'

The reply is 202 with a queued job; poll its status_url until status is succeeded or failed. See the quick start for the whole exchange.

Responses

What comes back

status	Meaning
`queued`	Accepted, waiting for the jobs ahead of it. `position` counts how many those are.
`running`	The tool is executing now.
`succeeded`	Finished; `result` holds the tool's output and `license` the terms it came under.
`failed`	Finished; `error` holds a code and a message.

Errors

code	Meaning
`invalid_input`	The client supplied invalid or incomplete input.
`tool_unavailable`	The requested third-party dependency is not available on this host.
`execution_failed`	A configured third-party process exited unsuccessfully.
`internal_error`	An adapter failed in a way it does not describe. The detail is in the server log, not the response.
`not_found`	No job has that id. Finished jobs are dropped eventually.