{ "openapi": "3.0.1", "info": { "title": "Scholarly Metadata: arXiv, OpenAlex and PubMed search", "description": "Searches arXiv, OpenAlex and PubMed, or looks up papers by DOI, arXiv id, PMID or OpenAlex id, and returns title, authors, abstract, dates, DOI, venue and links, within each source's rate limits.", "version": "0.1", "x-build-id": "Y1NznBOgUDds5ju8N" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/examsens.ai~scholarly-metadata/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-examsens.ai-scholarly-metadata", "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/examsens.ai~scholarly-metadata/runs": { "post": { "operationId": "runs-sync-examsens.ai-scholarly-metadata", "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/examsens.ai~scholarly-metadata/run-sync": { "post": { "operationId": "run-sync-examsens.ai-scholarly-metadata", "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 queries", "type": "array", "description": "Search terms. Each query runs on every selected source. arXiv field prefixes such as ti: and au: and PubMed field tags such as [au] pass through to that source.", "items": { "type": "string" } }, "ids": { "title": "Identifiers to look up", "type": "array", "description": "DOIs (10.1038/nature12373 or a doi.org link), arXiv ids (1706.03762), PubMed ids (PMID:31452104 or the bare number) and OpenAlex work ids (W2741809807).", "items": { "type": "string" } }, "sources": { "title": "Sources", "type": "array", "description": "Which sources to use.", "items": { "type": "string", "enum": [ "arxiv", "openalex", "pubmed" ], "enumTitles": [ "arXiv", "OpenAlex", "PubMed" ] }, "default": [ "arxiv", "openalex", "pubmed" ] }, "maxResultsPerQuery": { "title": "Maximum results per query and source", "minimum": 1, "maximum": 200, "type": "integer", "description": "Results kept for each query from each source.", "default": 25 }, "dateFrom": { "title": "Published from", "type": "string", "description": "Earliest publication or submission date for searches, as YYYY-MM-DD." }, "dateTo": { "title": "Published to", "type": "string", "description": "Latest publication or submission date for searches, as YYYY-MM-DD." }, "sortBy": { "title": "Sort searches by", "enum": [ "relevance", "newest" ], "type": "string", "description": "Relevance, or newest first.", "default": "relevance" }, "openAlexApiKey": { "title": "OpenAlex API key (optional)", "type": "string", "description": "Your own free OpenAlex key. Without one, OpenAlex allows a small daily budget, about 100 searches. Lookups by id are free." }, "ncbiApiKey": { "title": "NCBI API key (optional)", "type": "string", "description": "Your own NCBI key. It raises the PubMed rate from 3 to 10 requests a second." }, "contactEmail": { "title": "Contact email (optional)", "type": "string", "description": "Sent to PubMed in the email parameter and in the User-Agent header, so the services can reach you about your traffic. Leave empty to send none." } } }, "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 } } } } } } } } } }