{ "openapi": "3.0.1", "info": { "title": "Gene Target Dossier: NCBI, UniProt, PubMed & Trials", "description": "One clean record per gene: official name, summary, protein function, localization, disease links, publication volume, latest papers and clinical trials, joined from four public databases in one run.", "version": "1.1", "x-build-id": "MUd1Bb7xlB69lGRhp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/strange_code~gene-target-dossier/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-strange_code-gene-target-dossier", "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/strange_code~gene-target-dossier/runs": { "post": { "operationId": "runs-sync-strange_code-gene-target-dossier", "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/strange_code~gene-target-dossier/run-sync": { "post": { "operationId": "run-sync-strange_code-gene-target-dossier", "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": [ "genes" ], "properties": { "genes": { "title": "Gene symbols", "type": "array", "description": "Official gene symbols, one per line (e.g. BRCA1, TP53, KRAS).", "items": { "type": "string" } }, "organism": { "title": "Organism", "enum": [ "human", "mouse", "rat", "zebrafish", "fruit fly", "c. elegans", "yeast" ], "type": "string", "description": "Species to resolve symbols in.", "default": "human" }, "includeClinicalTrials": { "title": "Include clinical trials", "type": "boolean", "description": "Look up ClinicalTrials.gov studies mentioning each gene.", "default": true }, "activeTrialsOnly": { "title": "Active trials only", "type": "boolean", "description": "Only count recruiting / active / not-yet-recruiting trials.", "default": true }, "pubmedYears": { "title": "Recent-publication window (years)", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many recent years to count publications over (in addition to the all-time total).", "default": 5 }, "recentPapers": { "title": "Latest papers per gene", "minimum": 0, "maximum": 20, "type": "integer", "description": "Number of most recent PubMed papers to list for each gene (0 to skip).", "default": 5 }, "maxTrials": { "title": "Trials listed per gene", "minimum": 0, "maximum": 20, "type": "integer", "description": "Number of clinical trials to list for each gene (the total count is always included).", "default": 5 }, "exportAllTrials": { "title": "Export all clinical trials", "type": "boolean", "description": "Also save every matching ClinicalTrials.gov study for each gene as a separate CSV/JSON file (conditions, interventions, phase, sponsor, enrollment, dates, countries). Charged per trial row.", "default": false }, "exportAllPublications": { "title": "Export all publications", "type": "boolean", "description": "Also save every matching PubMed paper for each gene as a separate CSV/JSON file (title, journal, date, authors, DOI, publication types). Charged per paper row.", "default": false }, "publicationExportScope": { "title": "Publications to export", "enum": [ "recent window", "all time" ], "type": "string", "description": "Export papers from the recent-publication window only, or from all time.", "default": "recent window" }, "maxExportRowsPerGene": { "title": "Max export rows per gene", "minimum": 1, "maximum": 9999, "type": "integer", "description": "Upper limit on trials and on papers exported for each gene (newest papers first). PubMed allows at most 9,999 per query.", "default": 1000 }, "ncbiApiKey": { "title": "NCBI API key (optional)", "type": "string", "description": "Free key from your NCBI account; raises the rate limit and speeds up large batches." }, "contactEmail": { "title": "Contact email (optional)", "type": "string", "description": "Sent to NCBI as the 'email' parameter, as NCBI requests for heavy users." } } }, "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 } } } } } } } } } }