# browseIngredientGroups

**Identifier:** `dsld_browseIngredientGroups`

**Provider:** [DSLD](https://kirha.com/providers/dsld.md)

Browse dietary supplement ingredient groups by keyword. Useful for discovering available ingredients and their factsheet references.

## Run it with the CLI

```bash
kirha tools run dsld_browseIngredientGroups \
  --input '{
    "term": "Vitamin"
  }'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "dsld_browseIngredientGroups",
  "input": {
    "term": "Vitamin"
  }
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "default": 20,
      "maximum": 50,
      "minimum": 1,
      "type": "number"
    },
    "matchSynonyms": {
      "default": false,
      "description": "Also match the term against factsheet names",
      "type": "boolean"
    },
    "offset": {
      "default": 0,
      "maximum": 9950,
      "minimum": 0,
      "type": "number"
    },
    "term": {
      "description": "Whole word of an ingredient group name, e.g. Vitamin, Zinc. Partial words and single letters mostly match nothing",
      "type": "string"
    }
  },
  "required": [
    "term"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "context": {
      "type": "string"
    },
    "ingredientGroups": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "factsheetUrl": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "totalCount": {
      "type": "number"
    }
  },
  "required": [
    "context",
    "totalCount",
    "ingredientGroups"
  ],
  "type": "object"
}
```

-----

[All DSLD tools](https://kirha.com/providers/dsld.md) · [< Back to tools list](https://kirha.com/tools.md)