{ "openapi": "3.0.1", "info": { "title": "OpenAlex Scholarly Works Search - Papers, DOIs, Citations", "description": "Search 250M+ scholarly papers from OpenAlex by keyword, DOI, institution, year, open access and citation count. Returns title, journal, authors with affiliations, citations, topics and abstract. Official CC0 data, no personal identifiers.", "version": "0.1", "x-build-id": "x86B2bXYwoHYJkWK9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kdhan~openalex-scholarly-works-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kdhan-openalex-scholarly-works-search", "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/kdhan~openalex-scholarly-works-search/runs": { "post": { "operationId": "runs-sync-kdhan-openalex-scholarly-works-search", "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/kdhan~openalex-scholarly-works-search/run-sync": { "post": { "operationId": "run-sync-kdhan-openalex-scholarly-works-search", "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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Matched against title and abstract. Quotes make a phrase; AND, OR, NOT (uppercase) work. Each term is a separate search.", "items": { "type": "string" } }, "dois": { "title": "DOIs", "type": "array", "description": "Look up specific papers, for example 10.1021/tx400385x. Up to 100.", "items": { "type": "string" } }, "institutions": { "title": "Institutions", "type": "array", "description": "Institution names or OpenAlex IDs (I139264467). A name uses the best match, shown in the run log; sub-institutions are included.", "items": { "type": "string" } }, "publicationYearFrom": { "title": "Published from year", "type": "integer", "description": "First publication year to include." }, "publicationYearTo": { "title": "Published to year", "type": "integer", "description": "Last publication year to include." }, "openAccessOnly": { "title": "Open access only", "type": "boolean", "description": "Only works that are free to read.", "default": false }, "minCitations": { "title": "Minimum citations", "minimum": 0, "type": "integer", "description": "Only works cited at least this many times." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "cited_by_count", "publication_date" ], "type": "string", "description": "Relevance only applies when search terms are given.", "default": "relevance" }, "maxResults": { "title": "Maximum results per search term", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Upper limit of works returned for each search term. You are charged per work returned.", "default": 25 }, "apiKey": { "title": "OpenAlex API key (optional)", "type": "string", "description": "Your free key from openalex.org/settings/api-key (sign up at openalex.org/signup). Without it the small shared keyless daily limit applies and runs may fail." }, "contactEmail": { "title": "Contact email (optional)", "type": "string", "description": "Sent to OpenAlex as the mailto parameter so they can reach you about heavy use." } } }, "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 } } } } } } } } } }