> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAlex

> OpenAlex is an open catalog of scholarly works, authors, institutions, sources, topics, and related research metadata.

![OpenAlex logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/openalex.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=500ecc9323188873998b9a1d20bc290d)

* **Category:** web search & research
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 19
* **Triggers:** 0
* **Slug:** `OPENALEX`
* **Version:** 20261101\_00
* **Instant:** Supported on the latest version. Support varies by tool.

## Tools

> [accordion] Add Collection Entities
>
> **Slug:** `OPENALEX_ADD_COLLECTION_ENTITIES`
>
> Bulk-add one or more matching OpenAlex entity IDs to an owned collection without duplicating existing memberships.
>
> #### Input Parameters
>
> **entity\_ids** `array` *required*
>
> One to 1000 unique, nonempty OpenAlex IDs matching the collection's entity type.
>
> **collection\_id** `string` *required*
>
> Owned collection ID in col\_XXXXXXXXXX form.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Autocomplete Entities
>
> **Slug:** `OPENALEX_AUTOCOMPLETE_ENTITIES`
>
> Resolve a partial name or title to likely OpenAlex entity IDs before filtering or retrieving metadata.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0–\$0.001 per autocomplete request
>
> #### Input Parameters
>
> **query** `string` *required*
>
> Partial title or name to resolve.
>
> **filter** `string`
>
> Optional OpenAlex filter expression used to narrow candidates.
>
> **search** `string`
>
> Optional additional keyword constraint sent alongside query. Use query for the partial name or title and filter for an OpenAlex filter expression.
>
> **entity\_type** `string ("works" | "authors" | "sources" | "institutions" | "topics" | "keywords" | "publishers" | "funders")` *required*
>
> Entity type to resolve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Collection
>
> **Slug:** `OPENALEX_CREATE_COLLECTION`
>
> Create a private, single-entity-type OpenAlex collection, optionally with an initial bounded set of entity IDs.
>
> #### Input Parameters
>
> **entity\_ids** `array`
>
> Optional initial OpenAlex IDs of the selected entity type. Supply at most 1000 unique IDs.
>
> **description** `string`
>
> Optional collection description, up to 500 characters.
>
> **entity\_type** `string ("works" | "authors" | "sources" | "institutions" | "topics" | "sdgs" | "funders" | "publishers" | "keywords" | "concepts")` *required*
>
> The only OpenAlex entity type this collection may contain.
>
> **display\_name** `string` *required*
>
> Collection name (1-30 characters).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Collection
>
> **Slug:** `OPENALEX_DELETE_COLLECTION`
>
> Permanently delete exactly one owned private OpenAlex collection and all of its collection memberships. This does not delete the underlying OpenAlex entities.
>
> #### Input Parameters
>
> **collection\_id** `string` *required*
>
> Exact owned collection ID in col\_XXXXXXXXXX form to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Work Content
>
> **Slug:** `OPENALEX_DOWNLOAD_WORK_CONTENT`
>
> Download an OpenAlex-cached PDF or GROBID TEI file for a work, choosing the format matching its has\_content flags. Each call currently costs \$0.01, source copyright terms apply, and downloads are limited to 25 MB; managed downloads also limit expanded compressed TEI to 25 MB.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.01 per content download
>
> #### Input Parameters
>
> **format** `string ("pdf" | "tei_xml")` *required*
>
> Content format to download. Use pdf only when has\_content.pdf=true; use tei\_xml only when has\_content.grobid\_xml=true. TEI XML is returned as a gzip file.
>
> **work\_id** `string` *required*
>
> Short OpenAlex work ID, such as W3038568908.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Changefile
>
> **Slug:** `OPENALEX_GET_CHANGEFILE`
>
> Retrieve changed entity counts and JSONL/Parquet download details for one OpenAlex changefile date. Requires an OpenAlex paid plan; inspect GET\_RATE\_LIMIT\_STATUS for daily capacity and current endpoint cost.
>
> #### Input Parameters
>
> **date** `string` *required*
>
> Changefile date in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Collection
>
> **Slug:** `OPENALEX_GET_COLLECTION`
>
> Get metadata for one private OpenAlex collection owned by the connected user.
>
> #### Input Parameters
>
> **collection\_id** `string` *required*
>
> Collection ID in col\_XXXXXXXXXX form.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Concept
>
> **Slug:** `OPENALEX_GET_CONCEPT`
>
> Retrieve one item from the deprecated, frozen OpenAlex Concepts taxonomy for legacy workflows. Prefer Topics through GET\_ENTITY for new work; use select to limit returned fields.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> OpenAlex concept ID or canonical OpenAlex concept URL.
>
> **select** `string`
>
> Comma-separated top-level concept fields to return; omit for all fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Metadata Entity
>
> **Slug:** `OPENALEX_GET_ENTITY`
>
> Retrieve one OpenAlex work, author, source, institution, topic, keyword, publisher, funder, award, taxonomy item, country, continent, or language by its supported identifier. Returns the provider's entity object directly; use select to limit its top-level fields.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **id** `string` *required*
>
> OpenAlex ID or supported external ID: DOI/PMID/PMCID/MAG for works, ORCID for authors, ISSN for sources, ROR for institutions, Crossref ID for funders, ISO code for countries/languages, or the documented resource ID. Bare work DOIs such as 10.7717/peerj.4375 are accepted and converted to OpenAlex's canonical [https://doi.org/](https://doi.org/) form.
>
> **select** `string`
>
> Comma-separated top-level fields to return; omit for the complete entity.
>
> **entity\_type** `string ("works" | "authors" | "sources" | "institutions" | "topics" | "keywords" | "publishers" | "funders" | "awards" | "domains" | "fields" | "subfields" | "sdgs" | "countries" | "continents" | "languages")` *required*
>
> Entity resource matching the identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Rate Limit Status
>
> **Slug:** `OPENALEX_GET_RATE_LIMIT_STATUS`
>
> Validate the connected OpenAlex API key and inspect daily budget, prepaid balance, reset timing, and current endpoint costs before expensive queries or downloads.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Infer Topics from Text
>
> **Slug:** `OPENALEX_INFER_TOPICS_FROM_TEXT`
>
> Use OpenAlex's deprecated legacy classifier to infer topics from a required title, optionally accompanied by an abstract. Not recommended for new projects; costs \$0.01 per request.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Title text to classify. Title plus optional abstract must contain 20-2000 combined trimmed characters.
>
> **abstract** `string`
>
> Optional abstract text used with the title. Combined trimmed title and abstract length must be 20-2000 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Changefiles
>
> **Slug:** `OPENALEX_LIST_CHANGEFILES`
>
> List all available OpenAlex changefile dates and detail URLs. Requires an OpenAlex paid plan. Keep aggregate traffic below 100 requests per second and inspect GET\_RATE\_LIMIT\_STATUS for daily capacity and current endpoint cost.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Collection Entities
>
> **Slug:** `OPENALEX_LIST_COLLECTION_ENTITIES`
>
> List one page of entity IDs in an owned private collection together with collection metadata and page totals.
>
> #### Input Parameters
>
> **page** `integer`
>
> One-based page number.
>
> **per\_page** `integer`
>
> Maximum entity IDs in this page (1-200).
>
> **collection\_id** `string` *required*
>
> Owned collection ID in col\_XXXXXXXXXX form.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List My Collections
>
> **Slug:** `OPENALEX_LIST_MY_COLLECTIONS`
>
> List private OpenAlex collections owned by the connected API-key user, optionally finding collections that contain an entity.
>
> #### Input Parameters
>
> **page** `integer`
>
> One-based page number.
>
> **per\_page** `integer`
>
> Maximum collections in this page (1-100).
>
> **entity\_id** `string`
>
> Entity ID used to find owned collections containing that entity.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Concepts
>
> **Slug:** `OPENALEX_QUERY_CONCEPTS`
>
> Query the deprecated, frozen OpenAlex Concepts taxonomy for legacy workflows. Prefer Topics through QUERY\_ENTITIES for new work. Returns one cursor-controlled page; keep aggregate traffic below 100 requests per second and monitor the connected key's daily USD budget.
>
> #### Input Parameters
>
> **sort** `string`
>
> Concept sort expression such as cited\_by\_count:desc. Cannot be combined with sample.
>
> **cursor** `string`
>
> Omit for the first page, or pass the prior next\_cursor unchanged for the next page.
>
> **filter** `string`
>
> OpenAlex concept filter expression. Separate AND clauses with commas and OR values with pipes.
>
> **sample** `integer`
>
> Random sample size from 1 to 10000. Cannot be combined with sort.
>
> **search** `string`
>
> Keyword search over concept names and descriptions.
>
> **select** `string`
>
> Comma-separated top-level concept fields to return.
>
> **group\_by** `string`
>
> Supported concept field to aggregate instead of returning concepts.
>
> **per\_page** `integer`
>
> Maximum concepts or groups in this page (1-100).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Metadata Entities
>
> **Slug:** `OPENALEX_QUERY_ENTITIES`
>
> Search, filter, sort, sample, select, or group one OpenAlex metadata resource other than works, including authors, venues, organizations, taxonomy, geography, awards, and enumerations. Returns one cursor-controlled page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.001 per 10 list/filter calls or \$0.001 per search calls
>
> **Discount:** 100
>
> #### Input Parameters
>
> **sort** `string`
>
> Resource-specific sort expression, such as cited\_by\_count:desc.
>
> **cursor** `string`
>
> Use \* for the first cursor-controlled page, or pass the previous response's next\_cursor unchanged to fetch the next page.
>
> **filter** `string`
>
> Resource-specific OpenAlex filter expression. Separate AND clauses with commas and OR values with pipes.
>
> **sample** `integer`
>
> Optional random sample size from 1 to 10000; cannot be combined with sort.
>
> **search** `string`
>
> Resource-specific keyword search over documented names and descriptions.
>
> **select** `string`
>
> Comma-separated top-level response fields to reduce payload.
>
> **group\_by** `string`
>
> Supported field to aggregate. Grouped responses contain group rows instead of entities.
>
> **per\_page** `integer`
>
> Maximum entities or groups in this page (1-100).
>
> **entity\_type** `string ("authors" | "sources" | "institutions" | "topics" | "keywords" | "publishers" | "funders" | "awards" | "domains" | "fields" | "subfields" | "sdgs" | "countries" | "continents" | "languages" | "work-types" | "source-types" | "institution-types" | "licenses" | "indexes")` *required*
>
> Metadata resource to query. Use sources for journals and repositories, and institutions for organizations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Works
>
> **Slug:** `OPENALEX_QUERY_WORKS`
>
> Search, filter, sort, sample, select, or group scholarly works, returning one cursor-controlled page; use the snapshot for whole-catalog exports. Query cost may be omitted under managed access, which also rejects collection references in filters.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.001 per 10 list/filter calls or \$0.001 per search calls
>
> **Discount:** 100
>
> #### Input Parameters
>
> **seed** `integer`
>
> Seed for a repeatable random sample. Valid only when sample is set.
>
> **sort** `string`
>
> Work sort expression. Cannot be combined with sample.
>
> **cursor** `string`
>
> Use \* for the first page or pass the prior next\_cursor unchanged for the next page.
>
> **filter** `string`
>
> OpenAlex filter expression. Commas mean AND and pipes mean OR.
>
> **sample** `integer`
>
> Random sample size (1-10000). Cannot be combined with sort.
>
> **search** `string`
>
> Keyword search across work titles, abstracts, and indexed full text.
>
> **select** `string`
>
> Comma-separated top-level work fields to return.
>
> **group\_by** `string`
>
> Supported work field to aggregate instead of returning work records.
>
> **per\_page** `integer`
>
> Maximum works or groups in this page (1-100).
>
> **exact\_search** `string`
>
> Unstemmed exact search. Cannot be combined with another search mode.
>
> **semantic\_search** `string`
>
> Meaning-based search. Cannot be combined with another search mode and currently costs \$0.001 per call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Collection Entities
>
> **Slug:** `OPENALEX_REMOVE_COLLECTION_ENTITIES`
>
> Bulk-remove one or more entity memberships from an owned private OpenAlex collection without deleting the underlying OpenAlex entities.
>
> #### Input Parameters
>
> **entity\_ids** `array` *required*
>
> One to 1000 unique, exact OpenAlex entity IDs to remove.
>
> **collection\_id** `string` *required*
>
> Owned collection ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Collection
>
> **Slug:** `OPENALEX_UPDATE_COLLECTION`
>
> Update a private collection's name or description, or change its entity type while the collection is empty. Provide at least one of display\_name, description, or entity\_type.
>
> #### Input Parameters
>
> **description** `string`
>
> New description, up to 500 characters. Use an empty string to clear it.
>
> **entity\_type** `string ("works" | "authors" | "sources" | "institutions" | "topics" | "sdgs" | "funders" | "publishers" | "keywords" | "concepts")`
>
> New entity type. OpenAlex permits this change only while the collection is empty.
>
> **display\_name** `string`
>
> New collection name (1-30 characters).
>
> **collection\_id** `string` *required*
>
> Owned collection ID in col\_XXXXXXXXXX form. At least one update field is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
