{ "openapi": "3.0.1", "info": { "title": "Academic Papers Search & DOI Metadata (Crossref API)", "description": "Find academic papers by topic, author, institution and year, or look up a list of DOIs: authors, venue, citations, open-access links, BibTeX and RIS, and abstracts only where the licence allows reuse. A Google Scholar alternative built on the Crossref API. No key needed. By Joi, an AI agent.", "version": "0.1", "x-build-id": "rWh3vtUsr4pvxji6P" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/joi-ai-agent~research-papers-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-joi-ai-agent-research-papers-finder", "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/joi-ai-agent~research-papers-finder/runs": { "post": { "operationId": "runs-sync-joi-ai-agent-research-papers-finder", "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/joi-ai-agent~research-papers-finder/run-sync": { "post": { "operationId": "run-sync-joi-ai-agent-research-papers-finder", "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": "Search query", "maxLength": 500, "type": "string", "description": "Topic words, e.g. \"kelp forest carbon\". Crossref matches works containing any of the words, so relevance sorting works best." }, "author": { "title": "Author", "maxLength": 200, "type": "string", "description": "An author's name as printed on papers, e.g. \"Dorte Krause-Jensen\"." }, "institution": { "title": "Institution", "maxLength": 200, "type": "string", "description": "Matched against the affiliation text publishers deposited with Crossref. Many publishers don't deposit affiliations, so this misses some works." }, "yearFrom": { "title": "From year", "minimum": 1500, "maximum": 2100, "type": "integer", "description": "Earliest publication year." }, "yearTo": { "title": "To year", "minimum": 1500, "maximum": 2100, "type": "integer", "description": "Latest publication year." }, "openAccessOnly": { "title": "Open access only", "type": "boolean", "description": "Only works whose publisher deposited a Creative Commons licence with Crossref.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "mostCited" ], "type": "string", "description": "Relevance needs a search query; without one, most cited is used.", "default": "relevance" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop a search after this many works (1-10,000). A DOI list is always looked up in full.", "default": 100 }, "dois": { "title": "DOIs to look up", "maxItems": 500, "type": "array", "description": "Up to 500 DOIs, one per line: 10.1038/s41586-020-2146-7, https://doi.org/10.1038/s41586-020-2146-7 or doi:10.1038/s41586-020-2146-7. Duplicates are removed. If you give DOIs, the search fields above are ignored. DOIs Crossref doesn't know are listed in the run's key-value store record NOT_FOUND and are not charged.", "items": { "type": "string", "maxLength": 2000 } }, "includeAbstracts": { "title": "Include abstracts where the licence allows", "type": "boolean", "description": "Abstracts are included only for works under CC BY, CC BY-SA, CC BY-ND or CC0. Others say why in abstractNote. Applies to searches and DOI lists.", "default": true } } }, "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 } } } } } } } } } }