{ "openapi": "3.0.1", "info": { "title": "DOI / PMID / arXiv → Academic Work Markdown", "description": "Batch DOI, PubMed PMID and arXiv ids (+ optional keyword queries) → scholarly-work Markdown RAG cards + JSON from public Crossref, OpenAlex, PubMed E-utilities and arXiv APIs. Keyless; optional buyer API keys. Failed / not-found rows free. 256 MB.", "version": "0.1", "x-build-id": "Mc7gbJtnfM6xaJV8P" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ingenious_quip_bxq~academic-works-markdown/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ingenious_quip_bxq-academic-works-markdown", "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/ingenious_quip_bxq~academic-works-markdown/runs": { "post": { "operationId": "runs-sync-ingenious_quip_bxq-academic-works-markdown", "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/ingenious_quip_bxq~academic-works-markdown/run-sync": { "post": { "operationId": "run-sync-ingenious_quip_bxq-academic-works-markdown", "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": { "ids": { "title": "DOI / PMID / arXiv ids", "type": "array", "description": "DOIs (10.x/… or doi.org URLs), PubMed PMIDs, arXiv ids or URLs. One per line.", "items": { "type": "string" } }, "queries": { "title": "Keyword queries", "type": "array", "description": "Optional free-text searches (OpenAlex by default; provider-specific otherwise).", "items": { "type": "string" } }, "provider": { "title": "Provider", "enum": [ "auto", "crossref", "openalex", "pubmed", "arxiv" ], "type": "string", "description": "auto = best source per id type + OpenAlex enrichment.", "default": "auto" }, "enrich": { "title": "Enrich with OpenAlex", "type": "boolean", "description": "Add citation counts / OA status via exact-id OpenAlex lookup.", "default": true }, "includeAbstract": { "title": "Include abstract", "type": "boolean", "description": "", "default": true }, "includeBibtex": { "title": "Include BibTeX", "type": "boolean", "description": "Generated from returned metadata only.", "default": true }, "includeRagChunks": { "title": "Write CHUNKS.jsonl", "type": "boolean", "description": "", "default": true }, "abstractMaxChars": { "title": "Abstract max chars", "minimum": 200, "maximum": 50000, "type": "integer", "description": "", "default": 4000 }, "maxAuthors": { "title": "Max authors per card", "minimum": 1, "maximum": 2000, "type": "integer", "description": "", "default": 100 }, "searchLimit": { "title": "Hits per query", "minimum": 1, "maximum": 50, "type": "integer", "description": "", "default": 5 }, "maxItems": { "title": "Max cards", "minimum": 0, "type": "integer", "description": "Cap on total cards (0 = unlimited).", "default": 50 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "", "default": 2 }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 6, "type": "integer", "description": "", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout (s)", "minimum": 5, "maximum": 120, "type": "integer", "description": "", "default": 30 }, "contactEmail": { "title": "Contact email (optional)", "type": "string", "description": "Sent as mailto to Crossref/OpenAlex/NCBI polite pools. Defaults to a non-personal address." }, "openAlexApiKey": { "title": "OpenAlex API key (optional)", "type": "string", "description": "Your own OpenAlex key for higher quotas." }, "ncbiApiKey": { "title": "NCBI API key (optional)", "type": "string", "description": "Your own NCBI E-utilities key (10 req/s)." }, "datasetId": { "title": "Input dataset id", "type": "string", "description": "Read ids/queries from a dataset." }, "idField": { "title": "Id field", "type": "string", "description": "Field name holding the id in dataset/KV items." }, "keyValueStoreId": { "title": "Input KV store id", "type": "string", "description": "" }, "keyValueRecordKey": { "title": "KV record key", "type": "string", "description": "", "default": "INPUT_WORKS" } } }, "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 } } } } } } } } } }