{ "openapi": "3.0.1", "info": { "title": "Academic Paper Search: OpenAlex, Crossref, arXiv, PubMed", "description": "Search scholarly papers across OpenAlex, Crossref, arXiv and PubMed in one call: title, authors, year, venue, DOI, abstract, citation count and open-access link. $0.004 per 25 works. For literature reviews, research agents and RAG.", "version": "0.5", "x-build-id": "fgHzeFxhmOhZVM1Ra" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datagleaner~academic-literature-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datagleaner-academic-literature-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/datagleaner~academic-literature-search/runs": { "post": { "operationId": "runs-sync-datagleaner-academic-literature-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/datagleaner~academic-literature-search/run-sync": { "post": { "operationId": "run-sync-datagleaner-academic-literature-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": { "queries": { "title": "Search topics", "type": "array", "description": "Topics or keywords, one per line, e.g. `retrieval augmented generation` or `crispr base editing`. Each topic is searched separately in every chosen source. Leave this and DOIs empty to run a 5-work example.", "items": { "type": "string" } }, "dois": { "title": "DOIs to look up", "type": "array", "description": "Look up specific works by DOI, e.g. `10.1038/nature14539` or a doi.org link. Returned with the same fields as search results.", "items": { "type": "string" } }, "citationsFor": { "title": "Citation graph: DOIs", "type": "array", "description": "Citation-graph mode. For each DOI, return the works it cites (references) and/or the works that cite it, as ordinary rows with `relation` (`reference` or `citing`) and `seedDoi`. Uses OpenAlex, with OpenCitations as fallback. Max works per topic limits each direction per DOI. Each work is billed once per run, so a work shared by two seed DOIs appears under the first.", "items": { "type": "string" } }, "citationDirection": { "title": "Citation direction", "enum": [ "both", "references", "cited_by" ], "type": "string", "description": "Used with the citation-graph DOIs.", "default": "both" }, "sources": { "title": "Sources", "type": "array", "description": "Which sources to search. Results are merged by DOI and title, so a work found in several sources is one row.", "items": { "type": "string", "enum": [ "openalex", "crossref", "arxiv", "pubmed" ], "enumTitles": [ "OpenAlex (abstracts, citations, open access)", "Crossref (DOI metadata, citations)", "arXiv (preprints, abstracts)", "PubMed (biomedicine)" ] }, "default": [ "openalex", "crossref", "arxiv", "pubmed" ] }, "maxResults": { "title": "Max works per topic", "minimum": 1, "maximum": 500, "type": "integer", "description": "Works returned per topic after merging the sources (a DOI list counts as one topic). You pay per work returned.", "default": 25 }, "yearFrom": { "title": "Published from year", "minimum": 1000, "maximum": 3000, "type": "integer", "description": "Only works published in this year or later." }, "yearTo": { "title": "Published up to year", "minimum": 1000, "maximum": 3000, "type": "integer", "description": "Only works published in this year or earlier." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "citations", "newest" ], "type": "string", "description": "How each source ranks its matches before they are merged.", "default": "relevance" }, "openAccessOnly": { "title": "Open access only", "type": "boolean", "description": "Keep only works with a free full-text link (openAccessUrl).", "default": false }, "addCitationCounts": { "title": "Fill missing citation counts", "type": "boolean", "description": "For works whose source gives no citation count (arXiv, PubMed), look up the count in the OpenCitations index, up to 150 lookups per run.", "default": true }, "openalexApiKey": { "title": "OpenAlex API key (optional)", "type": "string", "description": "OpenAlex gives every user a free daily budget and a free key raises it. Without a key, OpenAlex may stop answering when the shared daily budget is used up; the other sources still run." } } }, "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 } } } } } } } } } }