Tools

List available tools

The tools this account can DISCOVER, each with its settings schema. Scoped to the caller. Fetch this rather than assuming a tool name.

Absence does not prove a tool is unsubmittable: custom tools deployed on the current platform are runnable, and their schemas are available at /tools/{name}/schema, but they are not listed here.

The finetuning tools (finetune: true) are listed here like any other, and also on their own by GET /models.

get/api/tools

Request

  • Base URL: https://app.tamarind.bio
  • URL: https://app.tamarind.bio/api/tools
  • Auth: API key in header x-api-key

Response

The available tools

namestring

The value to send as type when submitting.

finetuneboolean

True for a finetuning tool, which is submitted with POST /finetune (name it in model) rather than /submit-job.

displayNamestring
descriptionstring
githubstring
paperstring
outputTypesstring[]

What the tool declares it produces — molecular (pdb, sequence, sdf, smiles) alongside file and score types (csv, score, cif, …). A few tools use compound values such as pdb-list, so match by containment rather than equality.

This describes the ARTIFACTS a run leaves behind. To chain stages, match on taskType and the molecule types: a scoring stage passes its input type through even though its outputTypes says score. Absent means the tool declares nothing, which is unknown rather than "produces nothing"; and a type here is not proof the tool generated it, since a scoring tool can echo its input.

taskTypestring

The tool's pipeline task category (structure-prediction, inverse-folding, score, …) — the fact pipelines chain on. Absent for a tool that declares none.

filterMetricsstring[]

Metric names accepted in a pipeline stage's filter settings. Deliberately narrower than outputs.columns — /submit-pipeline rejects a filter on a column that is not filterable. Absent for tools whose filters are not validated.

Example response

[
  {
    "name": "alphafold",
    "settings": [
      {
        "extension": [
          "pdb",
          "cif"
        ]
      }
    ],
    "outputTypes": [
      "pdb"
    ],
    "taskType": "structure-prediction"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.