Autocomplete Species Name in Catalogue of Life
col.species.suggestAutocomplete a partial species or taxon name against the Catalogue of Life working draft, returning up to 25 ranked suggestions. Each suggestion includes the usage ID (for passing to col.species.detail or col.species.children), the matched name string, taxonomic rank, status (accepted/synonym), taxonomic group (e.g. "insects", "flowering plants", "birds"), higher-taxon context (e.g. "Hominidae"), and a human-readable suggestion string. Ideal for type-ahead name disambiguation in scientific workflows, species identification pipelines, or biodiversity data cleaning tasks. Optionally restrict suggestions to a specific rank (e.g. GENUS to return only genus-level matches).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rank | No | Restrict suggestions to a specific taxonomic rank (e.g. SPECIES, GENUS, FAMILY). Omit to return suggestions across all ranks. | |
| limit | No | Maximum number of autocomplete suggestions to return (1–25, default 10). | |
| query | Yes | Partial or full name prefix for autocomplete (e.g. "Homo", "Pinus syl", "Pan tr"). Returns ranked suggestions from the COL working draft. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present only when the call failed. Includes error code, message, request_id, and any provider-specific extras. | |
| result | No | Tool response payload. Shape varies per tool — consult the tool description and inputSchema. May be an object, array, string, or number depending on the upstream provider response. |