Obis Tools#

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

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

Available Tools#

OBIS_search_occurrences (Type: OBISOccurrenceTool)#

Retrieve one cursor page of marine occurrence records from OBIS. The API ignores offset/from/page…

OBIS_search_occurrences tool specification

Tool Information:

  • Name: OBIS_search_occurrences

  • Type: OBISOccurrenceTool

  • Description: Retrieve one cursor page of marine occurrence records from OBIS. The API ignores offset/from/page; continue with metadata.next_after, which is the internal occurrence UUID field id (not Darwin Core occurrenceID). Exact total and one-record lookahead prevent silent truncation.

Parameters:

  • scientificname (string) (optional) Scientific name filter to restrict occurrences.

  • areaid (string) (optional) Area identifier filter (per OBIS API).

  • size (integer) (optional) Number of records in this cursor page (1–100).

  • after (string) (optional) Cursor from metadata.next_after. Must be the internal UUID in result field id, not occurrenceID.

Example Usage:

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

OBIS_search_taxa (Type: OBISTaxaTool)#

Resolve an exact scientific name through OBIS /taxon/{scientificname}. Returns same-name accepted…

OBIS_search_taxa tool specification

Tool Information:

  • Name: OBIS_search_taxa

  • Type: OBISTaxaTool

  • Description: Resolve an exact scientific name through OBIS /taxon/{scientificname}. Returns same-name accepted and unaccepted taxa with WoRMS taxonID/AphiaID, rank, status, accepted-name mapping, environment flags, and lineage. Uses local offset pagination over the complete response.

Parameters:

  • scientificname (string) (required) Scientific name query (e.g., ‘Gadus’).

  • size (integer) (optional) Number of taxon matches to return (1–100).

  • offset (integer) (optional) Zero-based local offset over exact-name matches. Continue with metadata.next_offset.

Example Usage:

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