API_KEY
openalex_api_key
Developer setup
No fields declared in this snapshot.
User connection
- OpenAlex API Keygeneric_api_key · stringRequired
OPENALEX
OpenAlex is an open catalog of scholarly works, authors, institutions, sources, topics, and related research metadata.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
14
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 1–14 of 14 actions
OPENALEX_ADD_COLLECTION_ENTITIES
Bulk-add one or more matching OpenAlex entity IDs to an owned collection without duplicating existing memberships.
Untrusted display-only summary
OPENALEX_AUTOCOMPLETE_ENTITIES
Resolve a partial name or title to likely OpenAlex entity IDs before filtering or retrieving metadata.
Untrusted display-only summary
OPENALEX_CREATE_COLLECTION
Create a private, single-entity-type OpenAlex collection, optionally with an initial bounded set of entity IDs.
Untrusted display-only summary
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.
Untrusted display-only summary
OPENALEX_DOWNLOAD_WORK_CONTENT
Download an OpenAlex-cached PDF or gzipped GROBID TEI file for a work. Choose the format matching the work's has_content flags. Each call currently costs $0.01, and source copyright terms still apply.
Untrusted display-only summary
OPENALEX_GET_COLLECTION
Get metadata for one private OpenAlex collection owned by the connected user.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
OPENALEX_LIST_COLLECTION_ENTITIES
List one page of entity IDs in an owned private collection together with collection metadata and page totals.
Untrusted display-only summary
OPENALEX_LIST_MY_COLLECTIONS
List private OpenAlex collections owned by the connected API-key user, optionally finding collections that contain an entity.
Untrusted display-only summary
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.
Untrusted display-only summary
OPENALEX_QUERY_WORKS
Search, filter, sort, sample, select, or group scholarly works. Returns one cursor-controlled page and its OpenAlex query cost; use the snapshot for whole-catalog exports.
Untrusted display-only summary
OPENALEX_REMOVE_COLLECTION_ENTITIES
Bulk-remove one or more entity memberships from an owned private OpenAlex collection without deleting the underlying OpenAlex entities.
Untrusted display-only summary
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.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.