Warhead Hunter PROTAC Target Module
API Version 0.1 · Production

Warhead Hunter API

Active programmatic access for job submission, batch submission, job monitoring, results manifests, cleaned ligand-bound structure retrieval, and downloadable Warhead Hunter outputs.

Open Job Browser Open Warhead Hunter
Everything shown below is configured for the production domain at https://warheadhunter.com unless marked unavailable for a specific curated example job.
Selected API Base
https://warheadhunter.com
Production domain selected. All generated calls use https://warheadhunter.com.
Workflow Story

API Workflow At A Glance

Submit jobs with target_name and search_query, monitor status, retrieve file manifests, download WAR_PDB structures, and automate downstream structure collection.

Input
Submit Job
POST target_name, search_query, and optional fasta_seq.
Status
Monitor
Poll active job status and browser monitor URLs.
Results
Manifest
Inspect key outputs, counts, and result paths.
Artifacts
Files
List WAR_PDB, SDF, SVG, table, HTML, and manifest files.
Download
ZIP Bundles
Download curated result bundles or WAR_PDB-only ZIP archives.
Scale
Batch API
Launch multiple jobs sequentially and monitor them as one batch.
Base URLs

Connection Options

The production domain is now the canonical base for both the web app and API. The in-page tester calls /api/health on https://warheadhunter.com.

Production API
https://warheadhunter.com

Canonical Warhead Hunter API base. Use this for browser requests, terminal curl, Python automation, batch jobs, examples, and artifact downloads.

Open Health Check
Same-Origin App
https://warheadhunter.com

The web app, job browser, Warhead Hunter form, curated examples, and downloadable results should all resolve through the same production host.

Open Job Browser Open Warhead Hunter
Active Endpoints

Implemented Route Groups

Health And Discovery

Lightweight service metadata and discovery routes.

  • GET /api/health

    Health, deployment metadata, and filesystem readiness status.

  • GET /api/manifest

    Implemented endpoint groups, base URLs, docs URLs, and companion links.

Job Monitoring And Export

Current job-state, summary, and archive retrieval.

  • GET /api/job_log/<job_id>

    Returns current in-memory job log/status for active jobs.

  • GET /api/job_summary/<job_id>

    Returns a lightweight per-job summary.

  • GET /api/jobs/<job_id>/download

    Downloads a ZIP bundle for the job, preferring a curated public results bundle when present.

  • GET /api/jobs/export

    Exports the job index as CSV.

Programmatic Job API

Single-job submission, status retrieval, result manifest access, file listing, and bundle download.

  • POST /api/jobs

    Submit a single Warhead Hunter job using target_name, search_query, and optional fasta_seq.

  • GET /api/jobs/<job_id>

    Read job metadata and status from durable job metadata plus live in-memory state when available.

  • GET /api/jobs/<job_id>/results

    Return a lightweight result manifest for job-derived outputs.

  • GET /api/jobs/<job_id>/files

    List safe job files with download URLs.

  • GET /api/jobs/<job_id>/files/<filename>

    Download one safe file from the job directory.

  • GET /api/jobs/<job_id>/bundle

    Download a ZIP bundle of safe result files for the job, preferring a curated public results bundle when present.

  • GET /api/jobs/<job_id>/war-pdbs

    List cleaned ligand-bound PDB files under TARGET_RESULTS/WAR_PDB for one job.

  • GET /api/jobs/<job_id>/war-pdbs.zip

    Download only the cleaned ligand-bound WAR_PDB files for one job.

  • GET /api/jobs/<job_id>/artifacts

    List classified job artifacts with kind and folder filters for automation workflows.

Batch Submission

Launch multiple jobs sequentially with lightweight batch metadata and aggregated status endpoints.

  • POST /api/batches

    Submit multiple jobs using the same input model as POST /api/jobs.

  • GET /api/batches/<batch_id>

    Read batch metadata and live/computed status for each submitted job.

  • GET /api/batches/<batch_id>/results

    Return per-job result manifest summaries for a batch.

Structure And Visualization Assets

Routes that serve SVG, PDB, protein-only PDB, SDF, and related structure assets.

  • GET /api/svg/...

    Implemented route family — exact path arguments should be confirmed from code.

  • GET /api/svg-plain/...

    Implemented route family — exact path arguments should be confirmed from code.

  • GET /api/pdb/...

    Implemented route family — exact path arguments should be confirmed from code.

  • GET /api/protein/...

    Implemented route family — exact path arguments should be confirmed from code.

  • GET /api/sdf/...

    Implemented route family — exact path arguments should be confirmed from code.

Ligand And Result Helpers

Routes that help the browser resolve ligand properties, chains, and mapped atom data.

  • GET /api/ligand_props/...

    Implemented route family — exact path arguments should be confirmed from code.

  • GET /api/ligand_chain/...

    Implemented route family — exact path arguments should be confirmed from code.

  • GET /api/sasa_overlay/...

    Implemented route family — exact path arguments should be confirmed from code.

  • GET /api/sasa_atommap/...

    Implemented route family — exact path arguments should be confirmed from code.

SASA Blueprint Endpoints

Programmatic atom-level solvent-exposure retrieval for job outputs.

  • GET /api/jobs/<job_id>/sasa/available

    Lists available chain and residue combinations for a PDB.

  • GET /api/jobs/<job_id>/sasa/atoms

    Returns atom-level SASA payloads for one ligand occurrence.

  • POST /api/jobs/<job_id>/sasa/bulk

    Bulk atom-level SASA lookup for multiple requests.

  • GET /api/jobs/<job_id>/sasa/residue_for_ligand

    Resolves residue ID from PDB, chain, and ligand code.

Curated Example Jobs

Read-only curated examples for exploring completed Warhead Hunter outputs and prepared ligand-bound structures.

  • GET /api/examples

    Lists curated completed example jobs and availability metadata.

  • GET /api/examples/<job_id>

    Returns metadata for one curated example job.

  • GET /api/examples/<job_id>/files

    Lists safe downloadable files for one curated example job.

  • GET /api/examples/<job_id>/files/<filename>

    Downloads one safe file from a curated example job.

  • GET /api/examples/<job_id>/bundle

    Downloads a ZIP bundle of safe result files for a curated example job, preferring a curated public results bundle when present.

  • GET /api/examples/<job_id>/war-pdbs

    List cleaned ligand-bound PDB files for one curated example job.

  • GET /api/examples/<job_id>/war-pdbs.zip

    Download only the cleaned ligand-bound WAR_PDB files for one curated example job.

  • GET /api/examples/<job_id>/artifacts

    List classified artifact files for one curated example job.

Indexed Jobs

Read-only job index aligned with the Past Jobs Browser.

  • GET /api/indexed-jobs

    Lists indexed jobs with optional filters such as protein, target, query, availability, limit, offset, and sort.

Verified Command-Line Workflow

Submit A Real Job Using The Active Input Model

1. Submit A Single Job


      

      

        

          

            
2. Monitor Job Status

            
          

          

        

        

          

            
3. Read Job Log

            
          

          

        

      

    

  


  

    

      

        

          
Results And Files

          
Manifest, Artifact Listing, And Download Routes

        

      

      

        

          

            
4. Results Manifest

            
          

          

        

        

          

            
5. List Job Files

            
          

          

        

        

          

            
6. List WAR_PDB Files

            
          

          

        

        

          

            
7. Download WAR_PDB ZIP

            
          

          

        

        

          

            
8. List SDF Files

            
          

          

        

        

          

            
9. List SVG Files

            
          

          

        

        

          

            
10. Download Result Bundle

            
          

          

        

      

    

  


  

    

      

        

          
Curated Examples

          
Read-Only Example Jobs

        

        
These examples are useful for testing output formats, downloading prepared structures, and building automation workflows without launching a new job.

      

      

        Example availability depends on the deployment. Unavailable examples remain documented but return available: false rather than crashing.
      

      

        
        

          
CRBN / cereblon

          

            

              
Job ID

              
b281996d

            

            

              
Protein

              
CRBN

            

            

              
Use Case

              
E3 ligase recruiter / PROTAC-oriented example

            

          

          

            
              Available
            
          

          

            Metadata
            Files
            Bundle
            WAR_PDB
          

        

        
        
        
        

          
HIV-1 Protease

          

            

              
Job ID

              
d750cfea

            

            

              
Protein

              
Protease

            

            

              
Use Case

              
viral enzyme / ligand-bound structure example

            

          

          

            
              Available
            
          

          

            Metadata
            Files
            Bundle
            WAR_PDB
          

        

        
        
        
      

      

        

          

            
11. List Curated Examples

            
          

          

        

        

          

            
12. Download Example WAR_PDB ZIP

            
          

          

        

      

    

  


  

    

      

        

          
Batch API

          
Launch Multiple Jobs Sequentially

        

        
The batch API reuses the same job submission logic as POST /api/jobs and stores lightweight batch metadata on disk.

      

      

        

          
13. Submit A Batch

          
        

        

      

      

        

          

            
14. Monitor Batch Status

            
          

          

        

        

          

            
15. Batch Results Summary

            
          

          

        

      

    

  


  

    

      

        

          
Python Automation

          
Reusable Workflows

        

        
Use the example scripts in docs/examples/ for reproducible submissions, WAR_PDB retrieval, bundle downloads, structure-library assembly, and PRosettaC staging.

      

      

        

          
Submit And Monitor

          
Submit one job, poll status, inspect the manifest, and optionally download the result bundle.

        

        

          
Build Structure Libraries

          
Filter indexed jobs, collect WAR_PDB, SDF, SVG, and table outputs, and stage them for notebook analysis.

        

        

          
Stage PROTAC Inputs

          
Retrieve cleaned ligand-bound PDBs and pair them with ligand SDFs for downstream modeling workflows such as PRosettaC staging.

        

      

    

  


  

    

      

        

          
Companion Ecosystem

          
Where The Outputs Can Flow Next

        

      

      

        
        PROTAC Builder
        
        E3 Ligandalyzer
        
        V-LiSEMOD