{ "openapi": "3.0.1", "info": { "title": "NPI Append: Match Clinician Names to NPI Numbers", "description": "Append NPIs to a list of clinicians by first and last name, state, and city. One row per record: the resolved NPI with a plain match tier, credential, specialty, licensed states, Medicare enrollment, OIG exclusion flag, and active status. Paste records or link a CSV. $5 per 1,000 records.", "version": "0.1", "x-build-id": "qBiXLqF2DbNvQB3qF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/overlookdata~npimcp-resolve/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-overlookdata-npimcp-resolve", "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/overlookdata~npimcp-resolve/runs": { "post": { "operationId": "runs-sync-overlookdata-npimcp-resolve", "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/overlookdata~npimcp-resolve/run-sync": { "post": { "operationId": "run-sync-overlookdata-npimcp-resolve", "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": { "records": { "title": "Records to resolve", "minItems": 1, "maxItems": 10000, "type": "array", "description": "Clinicians to match, one JSON object each. A first name (at least 2 letters) and a last name are required to get a match; optional fields are middle_name, state (2-letter code or full name), city, title (job title, used to prefer the right specialty), and id (your own key, echoed back). A record without a first name is returned as invalid_input with reason first_name_missing, and one without a last name with reason last_name_missing; both are still billed. Every record produces exactly one billable result row, including ambiguous, no_match, and invalid_input rows. Duplicates are resolved and billed each time. Capped at 10,000 records per run; a longer list is truncated and the dropped count is reported in the run's status message and log. Provide either this field or a CSV link, not both: if both are filled in, the run stops without billing anything, so clear this field (including the prefilled examples) to use a CSV." }, "csv_url": { "title": "CSV link (instead of records)", "pattern": "^https?://", "type": "string", "description": "A publicly fetchable link to a CSV file with a header row. Required columns: first_name and last_name (the run stops if either header is missing). Optional columns: middle_name, state, city, title, id. Headers are matched ignoring case, spaces, and underscores (First Name, first_name, and FIRSTNAME all work); other columns are ignored. Same rules as records: a row without a first name returns invalid_input (first_name_missing) and is billed, one billable row per data row, capped at 10,000 rows per run. Clear the records field (including the prefilled examples) when using this, or the run stops." }, "include_alternates": { "title": "Include alternates on ambiguous rows", "type": "boolean", "description": "When several providers fit a record equally well, list up to 3 of them (NPI, score, name, practice city and state, specialty) so you can pick by hand. Does not change billing.", "default": false } } }, "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 } } } } } } } } } }