Idigbio Tools#

Configuration File: idigbio_tools.json Tool Type: Local Tools Count: 4

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

Available Tools#

iDigBio_get_record (Type: iDigBioRecordTool)#

Retrieve a single iDigBio biodiversity specimen record by its UUID. Returns the curated summary p…

iDigBio_get_record tool specification

Tool Information:

  • Name: iDigBio_get_record

  • Type: iDigBioRecordTool

  • Description: Retrieve a single iDigBio biodiversity specimen record by its UUID. Returns the curated summary plus the full Darwin Core data record (all collection/locality/taxonomy fields). No API key required.

Parameters:

  • uuid (string) (required) iDigBio record UUID (from iDigBio_search_records).

Example Usage:

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

iDigBio_search_media (Type: iDigBioSearchTool)#

Search the iDigBio specimen MEDIA index (photographs and scans) with exact offset pagination. Met…

iDigBio_search_media tool specification

Tool Information:

  • Name: iDigBio_search_media

  • Type: iDigBioSearchTool

  • Description: Search the iDigBio specimen MEDIA index (photographs and scans) with exact offset pagination. Metadata reports the exact total, current offset, has_more and next_offset; continue until has_more is false. Returns media type, identifiers, creator, rights and access URIs. No API key required.

Parameters:

  • scientificname ([‘string’, ‘null’]) (optional) Full scientific name, e.g. ‘Puma concolor’.

  • genus ([‘string’, ‘null’]) (optional) Genus, e.g. ‘Puma’.

  • family ([‘string’, ‘null’]) (optional) Family name.

  • country ([‘string’, ‘null’]) (optional) Country, e.g. ‘United States’.

  • stateprovince ([‘string’, ‘null’]) (optional) State/province.

  • recordedby ([‘string’, ‘null’]) (optional) Collector name.

  • catalognumber ([‘string’, ‘null’]) (optional) Catalog number.

  • collectioncode ([‘string’, ‘null’]) (optional) Collection code.

  • phylum ([‘string’, ‘null’]) (optional) Phylum.

  • class ([‘string’, ‘null’]) (optional) Class.

  • order ([‘string’, ‘null’]) (optional) Order.

  • limit (integer) (optional) Media records per page (1-100).

  • offset (integer) (optional) Zero-based media offset. Continue with metadata.next_offset.

Example Usage:

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

iDigBio_search_records (Type: iDigBioSearchTool)#

Search iDigBio digitized biodiversity specimen records by taxon and/or locality with exact offset…

iDigBio_search_records tool specification

Tool Information:

  • Name: iDigBio_search_records

  • Type: iDigBioSearchTool

  • Description: Search iDigBio digitized biodiversity specimen records by taxon and/or locality with exact offset pagination. Metadata reports the exact total, current offset, has_more and next_offset; continue until has_more is false. Returns taxon, collector, locality and catalog identifiers. No API key required.

Parameters:

  • scientificname ([‘string’, ‘null’]) (optional) Full scientific name, e.g. ‘Puma concolor’.

  • genus ([‘string’, ‘null’]) (optional) Genus, e.g. ‘Quercus’.

  • family ([‘string’, ‘null’]) (optional) Family name.

  • country ([‘string’, ‘null’]) (optional) Country, e.g. ‘United States’.

  • stateprovince ([‘string’, ‘null’]) (optional) State/province.

  • recordedby ([‘string’, ‘null’]) (optional) Collector name.

  • catalognumber ([‘string’, ‘null’]) (optional) Catalog number.

  • collectioncode ([‘string’, ‘null’]) (optional) Collection code.

  • phylum ([‘string’, ‘null’]) (optional) Phylum.

  • class ([‘string’, ‘null’]) (optional) Class.

  • order ([‘string’, ‘null’]) (optional) Order.

  • limit (integer) (optional) Records per page (1-100).

  • offset (integer) (optional) Zero-based record offset. Continue with metadata.next_offset.

Example Usage:

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

iDigBio_summary_facets (Type: iDigBioSearchTool)#

Get aggregate specimen statistics from iDigBio for a Darwin Core query: the exact total record co…

iDigBio_summary_facets tool specification

Tool Information:

  • Name: iDigBio_summary_facets

  • Type: iDigBioSearchTool

  • Description: Get aggregate specimen statistics from iDigBio for a Darwin Core query: the exact total record count plus top-value facet breakdowns (e.g. specimens per country, institution, or collector). Unlike iDigBio_search_records (which only paginates raw records, max 100), this returns counts over the entire matching set, enabling distribution/abundance statistics without full pagination. Filter with scientificname, genus, family, country, etc.; set top_fields to the field(s) to break down by. No API key required.

Parameters:

  • scientificname ([‘string’, ‘null’]) (optional) Full scientific name, e.g. ‘Puma concolor’.

  • genus ([‘string’, ‘null’]) (optional) Genus, e.g. ‘Puma’.

  • family ([‘string’, ‘null’]) (optional) Family name.

  • country ([‘string’, ‘null’]) (optional) Country, e.g. ‘United States’.

  • stateprovince ([‘string’, ‘null’]) (optional) State/province.

  • recordedby ([‘string’, ‘null’]) (optional) Collector name.

  • phylum ([‘string’, ‘null’]) (optional) Phylum.

  • class ([‘string’, ‘null’]) (optional) Class.

  • order ([‘string’, ‘null’]) (optional) Order.

  • top_fields ([‘string’, ‘array’, ‘null’]) (optional) Darwin Core field(s) to break down counts by, e.g. ‘country’, ‘institutioncode’, or ‘recordedby’. Comma-separate multiple fields. If omitted, only the total count is returned.

  • count ([‘integer’, ‘null’]) (optional) Number of top values to return per facet field (default 10, max 100).

Example Usage:

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