Skip to main content
OpenAlex logo
  • 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

Slug: OPENALEX_ADD_COLLECTION_ENTITIESBulk-add one or more matching OpenAlex entity IDs to an owned collection without duplicating existing memberships.

Input Parameters

array
required
One to 1000 unique, nonempty OpenAlex IDs matching the collection’s entity type.
string
required
Owned collection ID in col_XXXXXXXXXX form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_AUTOCOMPLETE_ENTITIESResolve 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

string
required
Partial title or name to resolve.
string
Optional OpenAlex filter expression used to narrow candidates.
Optional additional keyword constraint sent alongside query. Use query for the partial name or title and filter for an OpenAlex filter expression.
string ("works" | "authors" | "sources" | "institutions" | "topics" | "keywords" | "publishers" | "funders")
required
Entity type to resolve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_CREATE_COLLECTIONCreate a private, single-entity-type OpenAlex collection, optionally with an initial bounded set of entity IDs.

Input Parameters

array
Optional initial OpenAlex IDs of the selected entity type. Supply at most 1000 unique IDs.
string
Optional collection description, up to 500 characters.
string ("works" | "authors" | "sources" | "institutions" | "topics" | "sdgs" | "funders" | "publishers" | "keywords" | "concepts")
required
The only OpenAlex entity type this collection may contain.
string
required
Collection name (1-30 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_DELETE_COLLECTIONPermanently delete exactly one owned private OpenAlex collection and all of its collection memberships. This does not delete the underlying OpenAlex entities.

Input Parameters

string
required
Exact owned collection ID in col_XXXXXXXXXX form to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_DOWNLOAD_WORK_CONTENTDownload 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

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.
string
required
Short OpenAlex work ID, such as W3038568908.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_GET_CHANGEFILERetrieve 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

string
required
Changefile date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_GET_COLLECTIONGet metadata for one private OpenAlex collection owned by the connected user.

Input Parameters

string
required
Collection ID in col_XXXXXXXXXX form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_GET_CONCEPTRetrieve 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

string
required
OpenAlex concept ID or canonical OpenAlex concept URL.
string
Comma-separated top-level concept fields to return; omit for all fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_GET_ENTITYRetrieve 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

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/ form.
string
Comma-separated top-level fields to return; omit for the complete entity.
string ("works" | "authors" | "sources" | "institutions" | "topics" | "keywords" | "publishers" | "funders" | "awards" | "domains" | "fields" | "subfields" | "sdgs" | "countries" | "continents" | "languages")
required
Entity resource matching the identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_GET_RATE_LIMIT_STATUSValidate the connected OpenAlex API key and inspect daily budget, prepaid balance, reset timing, and current endpoint costs before expensive queries or downloads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_INFER_TOPICS_FROM_TEXTUse 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

string
required
Title text to classify. Title plus optional abstract must contain 20-2000 combined trimmed characters.
string
Optional abstract text used with the title. Combined trimmed title and abstract length must be 20-2000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_LIST_CHANGEFILESList 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_LIST_COLLECTION_ENTITIESList one page of entity IDs in an owned private collection together with collection metadata and page totals.

Input Parameters

integer
One-based page number.
integer
Maximum entity IDs in this page (1-200).
string
required
Owned collection ID in col_XXXXXXXXXX form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_LIST_MY_COLLECTIONSList private OpenAlex collections owned by the connected API-key user, optionally finding collections that contain an entity.

Input Parameters

integer
One-based page number.
integer
Maximum collections in this page (1-100).
string
Entity ID used to find owned collections containing that entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_QUERY_CONCEPTSQuery 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

string
Concept sort expression such as cited_by_count:desc. Cannot be combined with sample.
string
Omit for the first page, or pass the prior next_cursor unchanged for the next page.
string
OpenAlex concept filter expression. Separate AND clauses with commas and OR values with pipes.
integer
Random sample size from 1 to 10000. Cannot be combined with sort.
string
Keyword search over concept names and descriptions.
string
Comma-separated top-level concept fields to return.
string
Supported concept field to aggregate instead of returning concepts.
integer
Maximum concepts or groups in this page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_QUERY_ENTITIESSearch, 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 callsDiscount: 100

Input Parameters

string
Resource-specific sort expression, such as cited_by_count:desc.
string
Use * for the first cursor-controlled page, or pass the previous response’s next_cursor unchanged to fetch the next page.
string
Resource-specific OpenAlex filter expression. Separate AND clauses with commas and OR values with pipes.
integer
Optional random sample size from 1 to 10000; cannot be combined with sort.
string
Resource-specific keyword search over documented names and descriptions.
string
Comma-separated top-level response fields to reduce payload.
string
Supported field to aggregate. Grouped responses contain group rows instead of entities.
integer
Maximum entities or groups in this page (1-100).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_QUERY_WORKSSearch, 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 callsDiscount: 100

Input Parameters

integer
Seed for a repeatable random sample. Valid only when sample is set.
string
Work sort expression. Cannot be combined with sample.
string
Use * for the first page or pass the prior next_cursor unchanged for the next page.
string
OpenAlex filter expression. Commas mean AND and pipes mean OR.
integer
Random sample size (1-10000). Cannot be combined with sort.
string
Keyword search across work titles, abstracts, and indexed full text.
string
Comma-separated top-level work fields to return.
string
Supported work field to aggregate instead of returning work records.
integer
Maximum works or groups in this page (1-100).
Unstemmed exact search. Cannot be combined with another search mode.
Meaning-based search. Cannot be combined with another search mode and currently costs $0.001 per call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_REMOVE_COLLECTION_ENTITIESBulk-remove one or more entity memberships from an owned private OpenAlex collection without deleting the underlying OpenAlex entities.

Input Parameters

array
required
One to 1000 unique, exact OpenAlex entity IDs to remove.
string
required
Owned collection ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENALEX_UPDATE_COLLECTIONUpdate 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

string
New description, up to 500 characters. Use an empty string to clear it.
string ("works" | "authors" | "sources" | "institutions" | "topics" | "sdgs" | "funders" | "publishers" | "keywords" | "concepts")
New entity type. OpenAlex permits this change only while the collection is empty.
string
New collection name (1-30 characters).
string
required
Owned collection ID in col_XXXXXXXXXX form. At least one update field is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not