{
  "openapi": "3.0.1",
  "info": {
    "title": "novaResearch : Deep Scholar Gap Finder with AI insights",
    "description": "A Python-based scholar research tool which helps in identifying potential gaps post deep research & analysis within existing released research papers.From scholarly sources, rank papers, analyze trends, & identify evidence-backed research gaps.\n-Research trends \n-Identified Gaps & future directions_",
    "version": "0.1",
    "x-build-id": "2bhzDqD5reOLmEdCP"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/abhish1ek~nova-research-deep-scholar/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-abhish1ek-nova-research-deep-scholar",
        "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/abhish1ek~nova-research-deep-scholar/runs": {
      "post": {
        "operationId": "runs-sync-abhish1ek-nova-research-deep-scholar",
        "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/abhish1ek~nova-research-deep-scholar/run-sync": {
      "post": {
        "operationId": "run-sync-abhish1ek-nova-research-deep-scholar",
        "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": [
          "query"
        ],
        "properties": {
          "query": {
            "title": "Research topic or query",
            "type": "string",
            "description": "Main topic to search and analyze, for example: multimodal learning healthcare"
          },
          "sources": {
            "title": "Sources",
            "type": "array",
            "description": "Academic sources to query for papers.",
            "items": {
              "type": "string",
              "enum": [
                "arxiv",
                "crossref",
                "openalex"
              ],
              "enumTitles": [
                "arXiv",
                "Crossref",
                "OpenAlex"
              ]
            },
            "default": [
              "arxiv",
              "crossref",
              "openalex"
            ]
          },
          "maxPapers": {
            "title": "Maximum papers",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Maximum number of papers to retrieve before normalization, deduplication, and ranking.",
            "default": 15
          },
          "analysisDepth": {
            "title": "Analysis depth",
            "enum": [
              "light",
              "standard",
              "deep"
            ],
            "type": "string",
            "description": "Controls how deeply the actor synthesizes trends and gaps.",
            "default": "standard"
          },
          "includeTrendAnalysis": {
            "title": "Include trend analysis",
            "type": "boolean",
            "description": "Whether to extract trend signals such as methods, benchmarks, institutions, and evaluation patterns.",
            "default": true
          },
          "detectResearchGaps": {
            "title": "Detect research gaps",
            "type": "boolean",
            "description": "Whether to run heuristic and LLM-backed research gap synthesis.",
            "default": true
          },
          "includePaperIdeas": {
            "title": "Include paper ideas",
            "type": "boolean",
            "description": "Whether to include possible future paper ideas in the output report, derived from identified research gaps.",
            "default": true
          },
          "maxPapersForLLM": {
            "title": "Max papers for LLM synthesis",
            "minimum": 5,
            "maximum": 100,
            "type": "integer",
            "description": "How many top-ranked papers to send into LLM-based gap synthesis. Lower values reduce cost and latency.",
            "default": 20
          },
          "sortPreference": {
            "title": "Sort preference",
            "enum": [
              "balanced",
              "relevance",
              "recency"
            ],
            "type": "string",
            "description": "Ranking preference for final paper ordering.",
            "default": "balanced"
          },
          "dateFrom": {
            "title": "Start date",
            "type": "string",
            "description": "Optional lower publication date bound in YYYY-MM-DD format."
          },
          "dateTo": {
            "title": "End date",
            "type": "string",
            "description": "Optional upper publication date bound in YYYY-MM-DD format."
          },
          "llmProvider": {
            "title": "LLM provider",
            "enum": [
              "nvidia"
            ],
            "type": "string",
            "description": "Provider used for structured gap synthesis. Use nvidia for ChatNVIDIA via langchain-nvidia-ai-endpoints.",
            "default": "nvidia"
          },
          "llmApiKey": {
            "title": "LLM API key",
            "type": "string",
            "description": "Optional provider API key override for this run. If left empty, the actor will use the environment variable, such as NVIDIA_API_KEY."
          },
          "llmModel": {
            "title": "LLM model",
            "type": "string",
            "description": "Model ID used for gap synthesis. Default is NVIDIA Nemotron 3 Super 120B A12B.",
            "default": "nvidia/nemotron-3-super-120b-a12b"
          },
          "llmTimeoutSeconds": {
            "title": "LLM timeout (seconds)",
            "minimum": 10,
            "maximum": 300,
            "type": "number",
            "description": "Maximum time to wait for an LLM response before falling back to heuristic gap detection. Lower values make the actor faster but may reduce gap quality.",
            "default": 60
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}