Sign in

v51

latestOpenAPI 3.0.1Apache License Version 2.0raw.githubusercontent.com2026-08-01304136381.9 KB
GA4GHV20

List one specific tool, acts as an anchor for self references

This endpoint returns one specific tool (which has ToolVersions nested inside it).

get/ga4gh/trs/v2/tools/{id}

Path parameters

idstring required

A unique identifier of the tool, scoped to this registry, for example 123456.

Response

A tool.

aliasesstring[]

Support for this parameter is optional for tool registries that support aliases. A list of strings that can be used to identify this tool which could be straight up URLs. This can be used to expose alternative ids (such as GUIDs) for a tool for registries. Can be used to match tools across registries.

checker_urlstring

Optional url to the checker tool that will exit successfully if this tool produced the expected result given test data.

descriptionstring

The description of the tool.

has_checkerboolean

Whether this tool has a checker tool associated with it.

idstring required

A unique identifier of the tool, scoped to this registry.

meta_versionstring

The version of this tool in the registry. Iterates when fields like the description, author, etc. are updated.

namestring

The name of the tool.

organizationstring required

The organization that published the image.

urlstring required

The URL for this tool in this registry.

Example response

{
  "id": "123456",
  "url": "http://agora.broadinstitute.org/tools/123456",
  "versions": [
    {
      "descriptor_type_version": {
        "CWL": [
          "v1.0.2"
        ],
        "NFL": [
          "DSL2"
        ],
        "WDL": [
          "1.0",
          "1.0"
        ]
      },
      "id": "v1",
      "images": [
        {
          "checksum": [
            {
              "checksum": "77af4d6b9913e693e8d0b4b294fa62ade6054e6b2f1ffb617ac955dd63fb0182",
              "type": "sha256"
            }
          ],
          "image_name": "[\"quay.io/seqware/seqware_full/1.1\",\"ubuntu:latest\"]",
          "registry_host": "[\"registry.hub.docker.com\"]"
        }
      ],
      "included_apps": [
        "https://bio.tools/tool/mytum.de/SNAP2/1",
        "https://bio.tools/bioexcel_seqqc"
      ],
      "url": "http://agora.broadinstitute.org/tools/123456/versions/1"
    }
  ]
}