Validate Forcefield
Validate that a protein can be parameterized with the specified forcefields.
This endpoint checks if all residues in the protein are recognized by OpenMM and can be assigned forcefield parameters. Call this before running expensive MD calculations to catch preparation issues early.
Excluded residues are ones the caller parameterizes itself rather than from the protein force field, so validation would otherwise fail on them for having no template.
:param exclude_residues: posted as the request body; a residue name (case-insensitive) excludes every non-polymer record and polymer residue with that name, while a 0-based global residue index (spanning polymers, non-polymers, waters, and branched entities, ordered by lowest atom ID) excludes that residue without naming it :raises HTTPException: 400 if the protein cannot be parameterized
Request
- Base URLhttps://api.rowansci.com (the document declares no server; this is the origin it was published from)
- AuthAPI key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Query parameters
Cookies
Request body
Response
Successful Response
Changes
No recorded changes to this operation across all 8 revisions of this API.