{ "openapi": "3.0.1", "info": { "title": "OpenAlex Papers Search + New Paper Alerts", "description": "Search scholarly papers in OpenAlex by keyword, author, institution, topic and year, with citation counts, open-access links and abstracts, or monitor for new papers since your last run. Beta.", "version": "0.2", "x-build-id": "XXsG6vAxINRoMX9q9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/transparent_meteorite~openalex-research-papers-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-transparent_meteorite-openalex-research-papers-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/transparent_meteorite~openalex-research-papers-monitor/runs": { "post": { "operationId": "runs-sync-transparent_meteorite-openalex-research-papers-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/transparent_meteorite~openalex-research-papers-monitor/run-sync": { "post": { "operationId": "run-sync-transparent_meteorite-openalex-research-papers-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "query": { "title": "Keyword search", "type": "string", "description": "Search titles, abstracts and full text, e.g. 'graph neural networks'. Can be combined with the filters below." }, "authors": { "title": "Authors", "type": "array", "description": "Author names, OpenAlex IDs (A123...) or ORCID iDs. Names resolve to the best OpenAlex match (shown in the run OUTPUT, check it).", "items": { "type": "string" } }, "institutions": { "title": "Institutions", "type": "array", "description": "Institution names, OpenAlex IDs (I123...) or ROR ids, e.g. 'MIT'. Names resolve to the best match.", "items": { "type": "string" } }, "topics": { "title": "Topics", "type": "array", "description": "Topic names or OpenAlex topic IDs (T123...), e.g. 'Machine learning in healthcare'.", "items": { "type": "string" } }, "dois": { "title": "DOIs (exact lookup)", "type": "array", "description": "Fetch these specific papers by DOI (https://doi.org/... or bare 10.xxxx/...).", "items": { "type": "string" } }, "yearFrom": { "title": "Published from year", "minimum": 1000, "maximum": 2100, "type": "integer", "description": "First publication year to include." }, "yearTo": { "title": "Published up to year", "minimum": 1000, "maximum": 2100, "type": "integer", "description": "Last publication year to include." }, "minCitations": { "title": "Minimum citations", "minimum": 0, "type": "integer", "description": "Only papers cited at least this many times.", "default": 0 }, "openAccessOnly": { "title": "Open access only", "type": "boolean", "description": "Only papers with a free full-text version.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "citations", "newest", "oldest" ], "type": "string", "description": "Order of results. Monitor mode defaults to newest.", "default": "relevance" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Cap on paper records delivered (and charged) this run.", "default": 25 }, "onlyNewSinceLastRun": { "title": "Monitor mode: only new since last run", "type": "boolean", "description": "Skip papers already delivered in a previous run (tracked in a named key-value store) and only look at recent publications (see Days back). Schedule the actor to get a feed of new papers; a repeat run with nothing new delivers and charges 0 results.", "default": false }, "daysBack": { "title": "Days back (monitor mode)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Monitor mode: look at papers published in the last N days (ignored if 'Published from year' is set).", "default": 30 }, "workTypes": { "title": "Work types", "type": "array", "description": "Optional OpenAlex types, e.g. article, preprint, review, dissertation, book-chapter.", "items": { "type": "string" } }, "excludeRetracted": { "title": "Exclude retracted papers", "type": "boolean", "description": "Drop papers flagged as retracted.", "default": true }, "stateStoreName": { "title": "Dedupe store name", "type": "string", "description": "Named key-value store that remembers delivered papers. Change it to keep separate monitors or reset dedupe.", "default": "openalex-papers-seen" }, "openAlexApiKey": { "title": "OpenAlex API key (optional)", "type": "string", "description": "Free key from openalex.org/settings/api. Without one, OpenAlex gives all keyless users on a network a small shared daily budget, so heavy runs may stop early; with a key you get your own." }, "contactEmail": { "title": "Contact email (optional)", "type": "string", "description": "Sent to OpenAlex as the polite-pool 'mailto' parameter." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }