{
  "openapi": "3.0.1",
  "info": {
    "title": "PubMed Evidence Table: Study Designs, Retractions & PRISMA",
    "description": "Search PubMed and get a screening-ready Excel evidence table: study design from NLM indexing, sample size quoted from the abstract (blank when unclear), retraction and correction status, PMID/DOI/PMC links, PRISMA-style counts, and RIS / Rayyan CSV / NBIB files for Rayyan, Covidence and EndNote.",
    "version": "0.1",
    "x-build-id": "NiYl2KvTUHTJWDWd3"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/pandadad0214~pubmed-evidence-table/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-pandadad0214-pubmed-evidence-table",
        "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/pandadad0214~pubmed-evidence-table/runs": {
      "post": {
        "operationId": "runs-sync-pandadad0214-pubmed-evidence-table",
        "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/pandadad0214~pubmed-evidence-table/run-sync": {
      "post": {
        "operationId": "run-sync-pandadad0214-pubmed-evidence-table",
        "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": [
          "queries"
        ],
        "properties": {
          "queries": {
            "title": "PubMed search strings",
            "type": "array",
            "description": "One or more PubMed queries, written exactly as you would in PubMed (field tags like [tiab], [mh], [pt] and AND / OR / NOT work). Records found by more than one query are counted once and reported as duplicates.",
            "items": {
              "type": "string"
            }
          },
          "dateFrom": {
            "title": "Published from",
            "type": "string",
            "description": "Optional. 2020, 2020-06 or 2020-06-30 (publication date)."
          },
          "dateTo": {
            "title": "Published to",
            "type": "string",
            "description": "Optional. 2025, 2025-12 or 2025-12-31."
          },
          "studyDesigns": {
            "title": "Study designs",
            "type": "array",
            "description": "Keep only these designs (PubMed publication types / MeSH). Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "rct",
                "clinical-trial",
                "meta-analysis",
                "systematic-review",
                "observational",
                "case-report",
                "guideline",
                "review"
              ],
              "enumTitles": [
                "Randomized controlled trials",
                "Clinical trials (any)",
                "Meta-analyses",
                "Systematic reviews",
                "Observational (cohort, case-control, cross-sectional)",
                "Case reports",
                "Guidelines",
                "Reviews"
              ]
            }
          },
          "excludeAnimalOnly": {
            "title": "Exclude animal-only studies",
            "type": "boolean",
            "description": "Removes records indexed with Animals but not Humans. Records not yet indexed are kept.",
            "default": false
          },
          "languages": {
            "title": "Languages",
            "type": "array",
            "description": "Optional, e.g. english, spanish. Leave empty for all.",
            "items": {
              "type": "string"
            }
          },
          "hasAbstract": {
            "title": "Only records with an abstract",
            "type": "boolean",
            "description": "Removes records without an abstract (often letters, editorials and older records).",
            "default": false
          },
          "freeFullTextOnly": {
            "title": "Free full text only",
            "type": "boolean",
            "description": "Keep only records PubMed links to a free full text.",
            "default": false
          },
          "excludePreprints": {
            "title": "Exclude preprints",
            "type": "boolean",
            "description": "Removes records with the Preprint publication type.",
            "default": false
          },
          "retractedArticles": {
            "title": "Retracted articles",
            "enum": [
              "flag",
              "exclude"
            ],
            "type": "string",
            "description": "Flag keeps them in the table, marked FIX (charged as returned articles). Exclude removes them before they are returned (not charged) and counts them in PRISMA.",
            "default": "flag"
          },
          "sortBy": {
            "title": "Order",
            "enum": [
              "relevance",
              "newest"
            ],
            "type": "string",
            "description": "Order of the table. PubMed best match or most recent first.",
            "default": "relevance"
          },
          "maxResults": {
            "title": "Maximum articles",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "You pay per returned article ($0.004 each), so this also caps the cost. Counts for everything not included are still reported.",
            "default": 200
          },
          "citationStyle": {
            "title": "Citation style",
            "enum": [
              "vancouver",
              "apa",
              "ieee",
              "harvard",
              "chicago",
              "mla"
            ],
            "type": "string",
            "description": "Style for the citation column and the CITATIONS file. Formatted by citeproc-js with the official CSL style.",
            "default": "vancouver"
          },
          "includeAbstracts": {
            "title": "Include abstracts",
            "type": "boolean",
            "description": "Include the abstract in the table and import files (recommended for screening).",
            "default": true
          },
          "ncbiApiKey": {
            "title": "NCBI API key (optional)",
            "type": "string",
            "description": "Optional. A free NCBI key raises the limit from 3 to 10 requests per second (faster big searches). Stored encrypted; never logged."
          },
          "contactEmail": {
            "title": "Contact email for NCBI / Crossref (optional)",
            "type": "string",
            "description": "Sent to NCBI and Crossref as the contact for this tool. Leave empty to use ours."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}