← API reference
Property prediction · Antibody design

DeepSP API

Predict 30 spatial developability descriptors for an antibody from sequence alone.

Runs DeepSP, a surrogate CNN that reproduces the spatial aggregation propensity and spatial charge map scores normally obtained from a molecular dynamics run, in each region of the variable domains, from the heavy and light chain sequences alone.

Web form Documentation ↗ Examples ↗ Paper ↗ Source code ↗ License ↗
Submit POST /api/deepsp/

Queues a run and returns 202 with the job.

Schema GET /api/deepsp/

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

Runtime

Installed by setup_system.sh into its own uv environment; the trained model ships with the checkout · Python app (uv) · Moderate (s)

License

Permissive. MIT (Lai Lab), weights included. Commercial use is unrestricted; confirm the repository's own licence before relying on that.

Example presets

Send {"preset": "mab1"} to load an example and its bundled inputs. Add other request fields to override its settings. The schema includes all presets under tool.presets.

presetDescription
mab1Official DeepSP_input.csv: mAb1 heavy/light variable-domain pair. Source ↗
mab2Official DeepSP_input.csv: mAb2 heavy/light variable-domain pair. Source ↗
mab3Official DeepSP_input.csv: mAb3 heavy/light variable-domain pair. Source ↗
mab4Official DeepSP_input.csv: mAb4 heavy/light variable-domain pair. Source ↗
mab5Official DeepSP_input.csv: mAb5 heavy/light variable-domain pair. Source ↗
mab6Official DeepSP_input.csv: mAb6 heavy/light variable-domain pair. Source ↗
mab7Official DeepSP_input.csv: mAb7 heavy/light variable-domain pair. Source ↗
mab8Official DeepSP_input.csv: mAb8 heavy/light variable-domain pair. Source ↗
mab9Official DeepSP_input.csv: mAb9 heavy/light variable-domain pair. Source ↗
mab10Official DeepSP_input.csv: mAb10 heavy/light variable-domain pair. Source ↗
mab11Official DeepSP_input.csv: mAb11 heavy/light variable-domain pair. Source ↗
mab12Official DeepSP_input.csv: mAb12 heavy/light variable-domain pair. Source ↗
mab13Official DeepSP_input.csv: mAb13 heavy/light variable-domain pair. Source ↗
mab14Official DeepSP_input.csv: mAb14 heavy/light variable-domain pair. Source ↗
mab15Official DeepSP_input.csv: mAb15 heavy/light variable-domain pair. Source ↗
mab16Official DeepSP_input.csv: mAb16 heavy/light variable-domain pair. Source ↗
6p8nOfficial DeepSP web app example, split into heavy and light variable domains. Source ↗
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 deepsp-demo Job name
heavy_sequence string textarea yes EVQLVESGGGLVQPGRSLRLSCAASGFTFDDYAMHWVRQAPGKGLEWVSAITWNSGHIDYADSVEGRFTISRDNAKNSLYLQMNSLRAED … Heavy-chain variable domain Variable domain only, using the 20 standard amino acids. One heavy/light pair per run. up to 1000 characters.
light_sequence string textarea yes DIQMTQSPSSLSASVGDRVTITCRASQGIRNYLAWYQQKPGKAPKLLIYAASTLQSGVPSRFSGSGSGTDFTLTISSLQPEDVATYYCQR … Light-chain variable domain Variable domain only, using the 20 standard amino acids. One heavy/light pair per run. up to 1000 characters.
Example

A request that runs

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

curl -X POST https://athanortools.com/api/deepsp/ \
  -H 'Content-Type: application/json' \
  -d '{
  "job_name": "deepsp-demo",
  "heavy_sequence": "EVQLVESGGGLVQPGRSLRLSCAASGFTFDDYAMHWVRQAPGKGLEWVSAITWNSGHIDYADSVEGRFTISRDNAKNSLYLQMNSLRAEDTAVYYCAKVSYLSTASSLDYWGQGTLVTVSS",
  "light_sequence": "DIQMTQSPSSLSASVGDRVTITCRASQGIRNYLAWYQQKPGKAPKLLIYAASTLQSGVPSRFSGSGSGTDFTLTISSLQPEDVATYYCQRYNRAPYTFGQGTKVEIK"
}'

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

statusMeaning
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.
cancelled Abandoned at the submitter's request; there is no result. A job cancelled before its turn never ran at all.

Errors

codeMeaning
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 tool 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.