A tool's settings as JSON Schema
The parameters this tool accepts, as a standard JSON Schema document, scoped to your account. Validate a settings object against it before submitting. Domain types JSON Schema cannot express (a PDB file, a residue selection) travel as strings and keep their original type under x-tamarind-type.
Resolved through the same classifier POST /submit-job uses, so the schema describes the tool version your submission will actually run. A tool you cannot see and one that does not exist both answer 404.
A custom tool that is mid-deploy (status In Queue or Running) also answers 404, because /submit-job refuses it in that state — the schema is unavailable until its deployment finishes rather than describing a contract you cannot submit.
This is a STATIC description, for code generation, form building and offline checking. To check a specific payload's FIELDS use POST /validate-job, which runs the same validator /submit-job does and so cannot disagree with it about field values. Note it validates fields only: it does not re-check org or team tool policy, or whether a custom tool is mid-deploy, so a job can still be refused at submission for those reasons.
Request
- Base URL: https://app.tamarind.bio
- URL: https://app.tamarind.bio/api/tools/{name}/schema
- Auth: API key in header x-api-key
Path parameters
The tool's name, as returned by GET /tools.
Query parameters
Describe a specific pinned build of a custom tool rather than the deployed one — the same version accepted by POST /submit-job.
Response
JSON Schema for the tool's settings
Changes
No recorded changes to this operation across all 1 revision of this API.