{
"openapi": "3.0.1",
"info": {
"title": "Citation Checker: Find Fake References and Check DOIs",
"description": "Check reference lists against Crossref, DataCite and OpenAlex. Each reference is verified, mismatch (with the fields that differ), not found (possibly made up) or ambiguous, with DOI, retraction flag, open-access link and a corrected APA or BibTeX citation.",
"version": "0.1",
"x-build-id": "YkNUP2fzartVBNsRp"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/fernandosord~citation-checker-doi-validator/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-fernandosord-citation-checker-doi-validator",
"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/fernandosord~citation-checker-doi-validator/runs": {
"post": {
"operationId": "runs-sync-fernandosord-citation-checker-doi-validator",
"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/fernandosord~citation-checker-doi-validator/run-sync": {
"post": {
"operationId": "run-sync-fernandosord-citation-checker-doi-validator",
"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": {
"references": {
"title": "References",
"type": "array",
"description": "One reference per item: a full citation in any style (APA, MLA, Chicago, Harvard, IEEE, Vancouver, Nature), a DOI, a doi.org link or an arXiv ID. An item can also hold a whole BibTeX entry.",
"items": {
"type": "string"
}
},
"text": {
"title": "Reference list (paste)",
"type": "string",
"description": "Paste a whole bibliography here: one reference per line, or references separated by blank lines. Numbered lists ([1], 1.) whose items wrap over several lines are joined. BibTeX pasted here is read as BibTeX."
},
"bibtex": {
"title": "BibTeX",
"type": "string",
"description": "BibTeX entries, for example an export from Zotero, Mendeley, JabRef or Overleaf. Entries need at least a title or a DOI."
},
"pdfUrls": {
"title": "PDF URLs",
"type": "array",
"description": "Direct links to PDF files whose reference section should be read and checked, for example https://arxiv.org/pdf/1706.03762. The Actor reads the text after the last \"References\" or \"Bibliography\" heading. Scanned PDFs without a text layer are not supported. Up to 20 PDFs and 500 references per PDF.",
"items": {
"type": "string"
}
},
"citationStyle": {
"title": "Style of corrected citations",
"enum": [
"apa",
"mla",
"chicago",
"harvard",
"ieee",
"vancouver",
"bibtex"
],
"type": "string",
"description": "Style of the formattedCitation field and the corrected bibliography. APA and BibTeX are always included as well.",
"default": "apa"
},
"crossrefMailto": {
"title": "Contact email for Crossref (optional)",
"type": "string",
"description": "Crossref serves requests that include a contact email from its faster \"polite\" pool: 3 searches a second instead of 1. Crossref uses the address only to contact you about problems with your requests. If empty, the CROSSREF_MAILTO environment variable is used, then the slower public pool."
},
"openAlexApiKey": {
"title": "OpenAlex API key (optional)",
"type": "string",
"description": "A free key from openalex.org/settings/api. Without one, OpenAlex search shares a small daily budget with everyone on the same IP address and is often unavailable on shared servers; references that only OpenAlex indexes (many conference papers without a DOI) may then come back as not found. If empty, the OPENALEX_API_KEY environment variable is used."
},
"useOpenAlexSearch": {
"title": "Search OpenAlex when Crossref and DataCite have no good match",
"type": "boolean",
"description": "Turn off to use OpenAlex only for open-access data and citation counts. With it off, a reference that Crossref and DataCite do not hold is reported as not found, even though OpenAlex might have it.",
"default": true
},
"maxReferences": {
"title": "Maximum references",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "References beyond this number are not checked and not charged.",
"default": 1000
}
}
},
"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
}
}
}
}
}
}
}
}
}
}