Smartapi Tools#

Configuration File: smartapi_tools.json Tool Type: Local Tools Count: 2

This page contains all tools defined in the smartapi_tools.json configuration file.

Available Tools#

SmartAPI_get_api (Type: SmartAPITool)#

Retrieve one SmartAPI registry entry’s full metadata: base URL(s), tags, contact, terms of servic…

SmartAPI_get_api tool specification

Tool Information:

  • Name: SmartAPI_get_api

  • Type: SmartAPITool

  • Description: Retrieve one SmartAPI registry entry’s full metadata: base URL(s), tags, contact, terms of service, and endpoint list, by its registry id or slug. Example: api_id=’myvariant’ returns the MyVariant.info API’s 5 endpoints including ‘/variant/{id}’ and ‘/query’. Use SmartAPI_search_apis to find an api_id or slug.

Parameters:

  • api_id (string) (required) SmartAPI registry id (32-char hash) or slug, e.g. ‘myvariant’.

Example Usage:

query = {
    "name": "SmartAPI_get_api",
    "arguments": {
        "api_id": "example_value"
    }
}
result = tu.run(query)

SmartAPI_search_apis (Type: SmartAPITool)#

Search the SmartAPI registry of ~270 biomedical web APIs (OpenAPI-described, many NCATS Translato…

SmartAPI_search_apis tool specification

Tool Information:

  • Name: SmartAPI_search_apis

  • Type: SmartAPITool

  • Description: Search the SmartAPI registry of ~270 biomedical web APIs (OpenAPI-described, many NCATS Translator components), by keyword or field-scoped query. Example: query=’variant’ or query=’tags.name:translator’. Returns each match’s api_id/slug, title, base URL, and tags. Use to discover APIs not yet wrapped in ToolUniverse, or resolve an API named in a paper to its base URL and endpoints via SmartAPI_get_api.

Parameters:

  • query (string) (required) Free-text keyword, or a field-scoped Lucene query like ‘tags.name:translator’.

  • limit ([‘integer’, ‘null’]) (optional) Max APIs to return, 1-100. Default 25.

Example Usage:

query = {
    "name": "SmartAPI_search_apis",
    "arguments": {
        "query": "example_value"
    }
}
result = tu.run(query)