Openalex Tools

Configuration File: openalex_tools.json Tool Type: Local Tools Count: 8

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

Available Tools

openalex_get_author (Type: OpenAlexRESTTool)

Get a single OpenAlex author by Author ID (A…). You can pass either the short ID (e.g., “A50012…

openalex_get_author tool specification

Tool Information:

• Name: openalex_get_author

• Type: OpenAlexRESTTool

• Description: Get a single OpenAlex author by Author ID (A…). You can pass either the short ID (e.g., “A5001226970”) or the full URL (e.g., “https://openalex.org/A5001226970”).

Parameters:

• author_id (string) (required) OpenAlex Author ID (A…) or full OpenAlex URL.

• mailto (string) (optional) Optional contact email for OpenAlex polite pool.

Example Usage:

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

openalex_get_institution (Type: OpenAlexRESTTool)

Get a single OpenAlex institution by Institution ID (I…). You can pass either the short ID (e.g…

openalex_get_institution tool specification

Tool Information:

• Name: openalex_get_institution

• Type: OpenAlexRESTTool

• Description: Get a single OpenAlex institution by Institution ID (I…). You can pass either the short ID (e.g., “I136199984”) or the full URL (e.g., “https://openalex.org/I136199984”).

Parameters:

• institution_id (string) (required) OpenAlex Institution ID (I…) or full OpenAlex URL.

• mailto (string) (optional) Optional contact email for OpenAlex polite pool.

Example Usage:

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

openalex_get_work (Type: OpenAlexRESTTool)

Get a single OpenAlex work (paper) by OpenAlex Work ID (W…). You can pass either the short ID (…

openalex_get_work tool specification

Tool Information:

• Name: openalex_get_work

• Type: OpenAlexRESTTool

• Description: Get a single OpenAlex work (paper) by OpenAlex Work ID (W…). You can pass either the short ID (e.g., “W2626778328”) or the full URL (e.g., “https://openalex.org/W2626778328”).

Parameters:

• openalex_id (string) (required) OpenAlex Work ID (W…) or full OpenAlex URL.

• mailto (string) (optional) Optional contact email for OpenAlex polite pool.

Example Usage:

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

openalex_get_work_by_doi (Type: OpenAlexRESTTool)

Get a single OpenAlex work (paper) by DOI. Provide a DOI string like “10.65215/2q58a426” (you can…

openalex_get_work_by_doi tool specification

Tool Information:

• Name: openalex_get_work_by_doi

• Type: OpenAlexRESTTool

• Description: Get a single OpenAlex work (paper) by DOI. Provide a DOI string like “10.65215/2q58a426” (you can also pass a DOI URL like “https://doi.org/10.65215/2q58a426”).

Parameters:

• doi (string) (required) DOI identifier (preferred) or DOI URL.

• mailto (string) (optional) Optional contact email for OpenAlex polite pool.

Example Usage:

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

openalex_literature_search (Type: OpenAlexTool)

Search for academic literature using OpenAlex API. Retrieves papers with title, abstract, authors…

openalex_literature_search tool specification

Tool Information:

• Name: openalex_literature_search

• Type: OpenAlexTool

• Description: Search for academic literature using OpenAlex API. Retrieves papers with title, abstract, authors, publication year, and organizational affiliations based on search keywords.

Parameters:

• search_keywords (string) (required) Keywords to search for in paper titles, abstracts, and content. Use relevant scientific terms or phrases.

• max_results (integer) (optional) Maximum number of papers to retrieve (default: 10, maximum: 200).

• year_from (integer) (optional) Start year for publication date filter (e.g., 2020). Optional parameter to limit search to papers published from this year onwards.

• year_to (integer) (optional) End year for publication date filter (e.g., 2023). Optional parameter to limit search to papers published up to this year.

• open_access (boolean) (optional) Filter for open access papers only. Set to true for open access papers, false for non-open access, or omit for all papers.

Example Usage:

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

openalex_search_authors (Type: OpenAlexRESTTool)

Search OpenAlex authors via the /authors endpoint. Use this to discover Author IDs (A…) and the…

openalex_search_authors tool specification

Tool Information:

• Name: openalex_search_authors

• Type: OpenAlexRESTTool

• Description: Search OpenAlex authors via the /authors endpoint. Use this to discover Author IDs (A…) and then fetch details with openalex_get_author.

Parameters:

• search (string) (required) Author name search query. Example: “Yann LeCun”.

• per_page (integer) (optional) Results per page (OpenAlex max 200).

• page (integer) (optional) Page number (1-indexed).

• mailto (string) (optional) Optional contact email for OpenAlex polite pool.

Example Usage:

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

openalex_search_institutions (Type: OpenAlexRESTTool)

Search OpenAlex institutions via the /institutions endpoint. Use this to discover Institution IDs…

openalex_search_institutions tool specification

Tool Information:

• Name: openalex_search_institutions

• Type: OpenAlexRESTTool

• Description: Search OpenAlex institutions via the /institutions endpoint. Use this to discover Institution IDs (I…) and then fetch details with openalex_get_institution.

Parameters:

• search (string) (required) Institution name search query. Example: “Harvard University”.

• per_page (integer) (optional) Results per page (OpenAlex max 200).

• page (integer) (optional) Page number (1-indexed).

• mailto (string) (optional) Optional contact email for OpenAlex polite pool.

Example Usage:

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

openalex_search_works (Type: OpenAlexRESTTool)

Search OpenAlex works (papers) via the /works endpoint. Use this to discover OpenAlex Work IDs (W…

openalex_search_works tool specification

Tool Information:

• Name: openalex_search_works

• Type: OpenAlexRESTTool

• Description: Search OpenAlex works (papers) via the /works endpoint. Use this to discover OpenAlex Work IDs (W…) and DOIs, then follow up with openalex_get_work or openalex_get_work_by_doi. For advanced filtering, pass a filter string like “from_publication_date:2020-01-01,is_oa:true”.

Parameters:

• search (string) (required) Full-text search query for works (title/abstract/etc.). Example: “attention is all you need”.

• filter (string) (optional) OpenAlex filter string (comma-separated). Example: “from_publication_date:2020-01-01,is_oa:true”.

• per_page (integer) (optional) Results per page (OpenAlex max 200).

• page (integer) (optional) Page number (1-indexed).

• sort (string) (optional) Sort order string, e.g. “cited_by_count:desc”.

• mailto (string) (optional) Optional contact email for OpenAlex polite pool. If omitted, ToolUniverse uses a default.

Example Usage:

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

Navigation

• Available Tools - Back to Tools Overview

• Tool Loading Tutorial - Loading Local Tools