Actions8
Keywords → Get
AI-generatedOverview
This node integrates with the OpenAlex API, a free and comprehensive index of scholarly papers, authors, institutions, keywords, and more. It allows users to retrieve detailed information about various academic resources by querying the OpenAlex database.
The "Get" operation for the "Keywords" resource fetches keyword-related data from OpenAlex. This can be useful for researchers, librarians, or developers who want to analyze or enrich datasets with scholarly keyword metadata. For example, you might use this node to find trending research topics, explore keyword relationships, or filter works by specific keywords.
Properties
| Name | Meaning |
|---|---|
| Your email address is required by OpenAlex to use their API. It is used to contact you in case of any issues with your requests. | |
| Filters | Filters to apply to the request, e.g., "is_oa:true" to filter for open access works. See OpenAlex API documentation for available filters. |
| Group By | Get counts of resources grouped by a specific field, e.g., group_by=has_doi returns counts of works with and without DOIs. See API docs for valid group-by fields. |
| ID | The unique identifier for the keyword resource. Optional; can be used to retrieve a single item directly by its ID. External IDs like DOI, PMID, PMCID, or MAG are also supported. |
| Search Query | A search string to query OpenAlex for keywords matching the query. |
| Random result | If set to true, returns a random keyword result instead of a specific resource. Cannot be combined with other parameters. Useful for sampling. |
| Results Page | Specifies which page of results to return (pagination). Minimum value is 1. |
| Select Fields | Comma-separated list of fields to include in the response, limiting the amount of data returned. For example, "id,display_name,doi" will only return those fields for each keyword. |
Output
The node outputs an array of JSON objects representing the retrieved keyword data from OpenAlex. Each object corresponds to a keyword resource and contains fields as returned by the OpenAlex API, potentially filtered by the "Select Fields" property.
If binary data were involved (not applicable here), it would be summarized accordingly, but this node deals exclusively with JSON data.
Dependencies
- Requires internet access to call the OpenAlex public API.
- Requires the user to provide a valid email address as part of the API request parameters (used by OpenAlex for contact purposes).
- No additional credentials or API keys are needed beyond the email.
- No special environment variables or n8n configurations are necessary.
Troubleshooting
- Missing or invalid email: The OpenAlex API requires an email parameter. Omitting it or providing an invalid email may cause the API to reject requests.
- Invalid filters or parameters: Using unsupported filter syntax or combining incompatible parameters (e.g., setting "Random result" to true along with other filters) may lead to errors or empty responses.
- Pagination issues: Requesting pages beyond the available range will return empty results.
- Network errors: Ensure that the n8n instance has internet connectivity to reach the OpenAlex API endpoint.
- API rate limits: Although OpenAlex is free, excessive requests might be throttled. Consider adding delays or handling HTTP 429 responses gracefully.