{
  "openapi": "3.0.1",
  "info": {
    "title": "OpenAlex Citation & Open-Access Works Explorer",
    "description": "Search OpenAlex's open catalog of scholarly works and authors, or pull every work tied to an author, journal/source or institution. Returns citations, open-access status, abstracts, authorships and topic tags per work.",
    "version": "2.0",
    "x-build-id": "N7bYgi4PEsoNePL68"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/vexaloom-labs~openalex-citation-and-open-access-works-explorer/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-vexaloom-labs-openalex-citation-and-open-access-works-explorer",
        "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/vexaloom-labs~openalex-citation-and-open-access-works-explorer/runs": {
      "post": {
        "operationId": "runs-sync-vexaloom-labs-openalex-citation-and-open-access-works-explorer",
        "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/vexaloom-labs~openalex-citation-and-open-access-works-explorer/run-sync": {
      "post": {
        "operationId": "run-sync-vexaloom-labs-openalex-citation-and-open-access-works-explorer",
        "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",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "What to fetch",
            "enum": [
              "searchWorks",
              "getCitations",
              "getReferences",
              "getCitationGraph",
              "searchAuthors",
              "byWorkIds",
              "byAuthorIds",
              "byVenueIds",
              "byInstitutionIds"
            ],
            "type": "string",
            "description": "Pick a search mode, a direct-lookup mode, or a citation direction.",
            "default": "searchWorks"
          },
          "searchQuery": {
            "title": "Search query",
            "type": "string",
            "description": "Keyword, phrase, or OpenAlex Boolean query. Used by searchWorks and searchAuthors. In searchWorks it may be omitted when at least one filter is set (filter-only browsing).",
            "default": "large language models"
          },
          "searchField": {
            "title": "Search in",
            "enum": [
              "default",
              "title",
              "titleAbstractKeywords",
              "titleAndAbstract",
              "abstract",
              "fulltext"
            ],
            "type": "string",
            "description": "Which text field the query searches. Title/abstract options are much cheaper and faster than full text.",
            "default": "default"
          },
          "workIds": {
            "title": "Work IDs / DOIs / PMIDs",
            "type": "array",
            "description": "Used by byWorkIds and as the citation seeds for getCitations / getReferences / getCitationGraph. Accepts OpenAlex W-IDs, DOI URLs, bare DOIs, PMIDs, PMCIDs and MAG IDs. Examples: W2741809807, https://doi.org/10.1145/3442188.3445922, pmid:25524000.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "authorIds": {
            "title": "Author IDs / ORCIDs",
            "type": "array",
            "description": "OpenAlex author IDs (A...) or ORCIDs, for byAuthorIds.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "venueIds": {
            "title": "Venue / source IDs / ISSNs",
            "type": "array",
            "description": "OpenAlex source IDs (S..., journal / repository / conference) or ISSNs, for byVenueIds. Examples: S4306400194 (arXiv), S137773608 (Nature), 0028-0836.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "institutionIds": {
            "title": "Institution IDs / ROR IDs",
            "type": "array",
            "description": "OpenAlex institution IDs (I...) or ROR URLs, for byInstitutionIds. Examples: I136199984 (Harvard), I32971472 (MIT), https://ror.org/042nb2s44.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "citationDirection": {
            "title": "Citation direction (getCitationGraph)",
            "enum": [
              "both",
              "citations",
              "references"
            ],
            "type": "string",
            "description": "Which side of the citation graph to walk when mode is getCitationGraph.",
            "default": "both"
          },
          "publicationYearMin": {
            "title": "Publication year from",
            "minimum": 1800,
            "maximum": 2100,
            "type": "integer",
            "description": "Drop works published before this year. Sent to OpenAlex as a server-side filter."
          },
          "publicationYearMax": {
            "title": "Publication year to",
            "minimum": 1800,
            "maximum": 2100,
            "type": "integer",
            "description": "Drop works published after this year. Sent to OpenAlex as a server-side filter."
          },
          "minCitedBy": {
            "title": "Minimum citations",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "Drop works cited fewer times than this. 0 means no minimum."
          },
          "openAccessOnly": {
            "title": "Open access only",
            "type": "boolean",
            "description": "Only return works with a free, legal full-text copy.",
            "default": false
          },
          "oaStatus": {
            "title": "Open-access status",
            "enum": [
              "any",
              "diamond",
              "gold",
              "green",
              "hybrid",
              "bronze",
              "closed"
            ],
            "type": "string",
            "description": "Filter by OpenAlex's OA colour. Any status other than 'any' also implies open access.",
            "default": "any"
          },
          "hasFulltextOnly": {
            "title": "Has searchable full text only",
            "type": "boolean",
            "description": "Only works where OpenAlex has machine-readable full text.",
            "default": false
          },
          "workType": {
            "title": "Work type",
            "enum": [
              "any",
              "article",
              "book",
              "book-chapter",
              "book-review",
              "conference-abstract",
              "conference-paper",
              "data-paper",
              "dataset",
              "dissertation",
              "editorial",
              "erratum",
              "letter",
              "other",
              "paratext",
              "peer-review",
              "preprint",
              "reference-entry",
              "report",
              "retraction",
              "review",
              "software",
              "software-paper",
              "standard",
              "study-registration",
              "supplementary-materials"
            ],
            "type": "string",
            "description": "Optional OpenAlex work type filter.",
            "default": "any"
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance_score:desc",
              "cited_by_count:desc",
              "cited_by_count:asc",
              "publication_date:desc",
              "publication_date:asc",
              "publication_year:desc",
              "publication_year:asc",
              "fwci:desc"
            ],
            "type": "string",
            "description": "Ordering for works. Relevance requires a search query; filter-only modes fall back to most cited.",
            "default": "relevance_score:desc"
          },
          "perPage": {
            "title": "Results per API page",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many records to request per page (1-100). Smaller pages keep the daily test cheap.",
            "default": 50
          },
          "startPage": {
            "title": "Start page",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Resume page-based paging from this page (1-10000 combined with perPage must stay within 10,000 results).",
            "default": 1
          },
          "useCursor": {
            "title": "Use cursor paging",
            "type": "boolean",
            "description": "Follow OpenAlex next_cursor pages instead of page numbers. Needs the optional free API key; without it the actor uses page paging.",
            "default": false
          },
          "startCursor": {
            "title": "Start cursor",
            "type": "string",
            "description": "Optional saved OpenAlex cursor for a resumable cursor-paged run. Leave empty to start from the beginning.",
            "default": ""
          },
          "customFilter": {
            "title": "Raw OpenAlex filter",
            "type": "string",
            "description": "Advanced: an extra OpenAlex filter expression, e.g. language:en,is_retracted:false or topics.id:T10102. Combined with the filters above.",
            "default": ""
          },
          "includeAbstract": {
            "title": "Include abstract",
            "type": "boolean",
            "description": "Reconstruct readable abstract text from OpenAlex's inverted index. No extra API calls.",
            "default": true
          },
          "includeAuthorships": {
            "title": "Include full authorships",
            "type": "boolean",
            "description": "Include every author, their affiliations and corresponding-author flag.",
            "default": true
          },
          "includeConcepts": {
            "title": "Include legacy concepts",
            "type": "boolean",
            "description": "Include OpenAlex's deprecated concept tags (kept for backward compatibility). Prefer topics.",
            "default": true
          },
          "includeTopics": {
            "title": "Include topics, keywords and SDGs",
            "type": "boolean",
            "description": "Include the current OpenAlex topic hierarchy, keyword tags and UN Sustainable Development Goals.",
            "default": true
          },
          "includeOpenAccessLocations": {
            "title": "Include every open-access copy",
            "type": "boolean",
            "description": "Include all OA landing pages / PDFs, licenses and the OpenAlex full-text PDF and TEI links when available.",
            "default": true
          },
          "includeCitationIds": {
            "title": "Include citation ID lists",
            "type": "boolean",
            "description": "Include referencedWorks / relatedWorks ID arrays and the citedBy API URL. Off by default because long reference lists make records large.",
            "default": false
          },
          "userAgentEmail": {
            "title": "Contact email (polite pool)",
            "type": "string",
            "description": "Email sent in the User-Agent so OpenAlex can contact you about API usage. The default works; supply your own for high-volume runs.",
            "default": "apify-actor@noreply.apify.com"
          },
          "apiKey": {
            "title": "OpenAlex API key (optional)",
            "type": "string",
            "description": "Optional free key from openalex.org/settings/api. Only needed for cursor paging past 10,000 results or a larger daily request budget. Never required.",
            "default": ""
          },
          "maxItems": {
            "title": "Max records",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Hard cap on emitted records.",
            "default": 50
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}