Sequence analysis · Antibody design

Antibody Annotator API

Number an antibody or TCR sequence and report its regions and liabilities.

Numbers each variable domain with the chosen scheme, reports the framework and CDR boundaries that follow from it, and flags the sequence motifs associated with glycosylation, deamidation, isomerisation, and oxidation in each region.

Web form Home page ↗ Source code ↗

Submit POST /api/antibody_annotator/

Queues a run and returns 202 with the job.

Schema GET /api/antibody_annotator/

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

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	`annotator-demo`	Job name
`fasta`	string file	yes	`>heavy EVQLVESGGGLVQPGGSLRLSCAASGFNIKDTYIHWVRQAPGKGLEWVARIYPTNGYTRYADSVKGRFTISADTSKNTAYLQM …`	Sequences (FASTA) One record per chain. Variable domains only; constant regions are not numbered. file types .fasta,.fa,.faa,.txt.
`numbering_scheme`	string select	no	`imgt`	Numbering scheme One of: `imgt`, `kabat`, `chothia`, `martin`, `aho`.
`receptor_type`	string select	no	`antibody`	Receptor type One of: `antibody`, `tcr`, `shark`, `unknown`.
`report_liabilities`	boolean checkbox	no	`true`	Report sequence liabilities

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/antibody_annotator/ \
  -H 'Content-Type: application/json' \
  -d '{
  "job_name": "annotator-demo",
  "fasta": ">heavy\nEVQLVESGGGLVQPGGSLRLSCAASGFNIKDTYIHWVRQAPGKGLEWVARIYPTNGYTRYADSVKGRFTISADTSKNTAYLQMNSLRAEDTAVYYCSRWGGDGFYAMDYWGQGTLVTVSS\n>light\nDIQMTQSPSSLSASVGDRVTITCRASQDVNTAVAWYQQKPGKAPKLLIYSASFLYSGVPSRFSGSRSGTDFTLTISSLQPEDFATYYCQQHYTTPPTFGQGTKVEIK",
  "numbering_scheme": "imgt",
  "receptor_type": "antibody",
  "report_liabilities": true
}'

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.