Look up modules
get_modulesBatched get_module — returns { modules: [...], errors: [...] } with full citation-anchored specs for up to 25 modules in one call.
Prefer this over multiple get_module calls when you have a known list of modules to fetch (e.g. preparing to call draw_patch_diagram across N modules, comparing several candidates side-by-side). One round trip vs. N.
Args:
module_ids: array of "/" strings. Up to 25 per call; duplicates are deduplicated.
Optional args (apply to every module in the batch, same semantics as get_module):
view: "concise" returns the id-card subset (name, manufacturer, hp, description, capabilities, production_status, replaced_by) for every module and drops the heavy arrays — the cheapest way to triage a list ("which of these are LFOs?"). "full" (default) returns complete specs. Ignored when fields is set.
fields: top-level keys to include on each module (e.g. ["jacks","parameters"]). id and _meta are always returned. Use this when you only need a slice across N modules (e.g. just jacks for draw_patch_diagram) instead of N full specs.
heading_filter / outline_offset / outline_limit: narrow and paginate each module's manual_outline.
Returns:
modules[]: GetModuleResponse for each id that resolved (same shape as get_module; narrowed when fields is set).
errors[]: { id, message } for each id that failed (e.g. unknown module). Other ids in the batch still resolve.
If you only need a single module, use get_module — same shape, one element. Need only jacks (e.g. for draw_patch_diagram)? Pass fields: ["jacks"] to skip the full specs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view | No | Optional: "concise" returns the id-card subset for every module in the batch and drops the heavy arrays — cheapest way to triage a list. "full" (default) returns complete specs. Ignored when `fields` is set. | |
| fields | No | Optional: top-level keys to include on every module in the batch (e.g. ["jacks","parameters"]) when you only need a slice — keeps a multi-module fetch from returning full specs. Omit for everything. id and _meta are always returned. Takes precedence over `view`. Same selectable keys as get_module. | |
| module_ids | Yes | ||
| outline_limit | No | Optional: max manual_outline entries per module (default 100, hard max 250). | |
| heading_filter | No | Optional: case-insensitive substring matched against manual_outline heading_path, applied to every module in the batch. | |
| outline_offset | No | Optional: zero-based manual_outline offset, applied to every module in the batch. |