{ "openapi": "3.0.1", "info": { "title": "Authorized Professional Directory Intelligence", "description": "Turn buyer-authorized or licensed professional directory exports into privacy-aware evidence, freshness, confidence gaps, review priority, and safe next actions without scraping or network requests.", "version": "0.2", "x-build-id": "b1tK9BGbjI2l3CPIa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zinin~doctoralia-directory/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zinin-doctoralia-directory", "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/zinin~doctoralia-directory/runs": { "post": { "operationId": "runs-sync-zinin-doctoralia-directory", "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/zinin~doctoralia-directory/run-sync": { "post": { "operationId": "run-sync-zinin-doctoralia-directory", "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": { "schemaVersion": { "title": "Contract version", "enum": [ "2.0" ], "type": "string", "description": "Closed public input contract version.", "default": "2.0" }, "authorization": { "title": "Rights confirmation", "enum": [ "I confirm I am authorized to process and deliver these professional records" ], "type": "string", "description": "Required for paid professional records.", "default": "I confirm I am authorized to process and deliver these professional records" }, "sourceContext": { "title": "Source context", "enum": [ "provider_licensed_export", "organization_owned_directory", "professional_consent_export", "other_authorized_source" ], "type": "string", "description": "Buyer-attested origin category for the authorized records.", "default": "provider_licensed_export" }, "professionals": { "title": "Authorized professional records", "minItems": 1, "maxItems": 100, "type": "array", "description": "One to 100 closed professional directory records. No contact details, review text, patient data, biography or free-text notes are accepted.", "items": { "type": "object", "additionalProperties": false, "required": [ "professionalId", "profileUrl", "name", "specialty", "sourceName", "sourceLicense" ], "properties": { "professionalId": { "title": "Professional ID", "description": "Stable identifier from the authorized source; unique within sourceName.", "type": "string", "minLength": 1, "maxLength": 160, "pattern": "\\S" }, "profileUrl": { "title": "Recorded profile URL", "description": "HTTPS evidence reference. The Actor records but never fetches or verifies it.", "type": "string", "minLength": 9, "maxLength": 500, "pattern": "^https://" }, "name": { "title": "Professional name", "description": "Name supplied by the authorized source; identity is not independently verified.", "type": "string", "minLength": 1, "maxLength": 240, "pattern": "\\S" }, "specialty": { "title": "Supplied specialty", "description": "Specialty label supplied by the source; not a credential assertion.", "type": "string", "minLength": 1, "maxLength": 240, "pattern": "\\S" }, "city": { "title": "Supplied city", "description": "Optional locality supplied by the source.", "type": "string", "minLength": 1, "maxLength": 160, "pattern": "\\S" }, "rating": { "title": "Supplied aggregate rating", "description": "Optional 0–5 aggregate from the source; methodology is not verified.", "type": "number", "minimum": 0, "maximum": 5 }, "reviewCount": { "title": "Supplied review count", "description": "Optional nonnegative aggregate count; review text is not accepted.", "type": "integer", "minimum": 0, "maximum": 10000000 }, "sourceName": { "title": "Licensed source label", "description": "Label for the authorized export or organization-owned directory.", "type": "string", "minLength": 1, "maxLength": 200, "pattern": "\\S" }, "sourceLicense": { "title": "Rights statement", "description": "Buyer-supplied statement describing downstream processing and delivery authority.", "type": "string", "minLength": 1, "maxLength": 500, "pattern": "\\S" }, "sourceRetrievedAt": { "title": "Source retrieved at", "description": "Optional UTC time when the authorized export observed this record.", "type": "string", "maxLength": 40, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,9})?Z$" } } } }, "items": { "title": "Legacy specialty:city queries", "maxItems": 25, "type": "array", "description": "Accepted only for migration. No Doctoralia or other directory page is fetched; the run emits one free migration diagnostic.", "items": { "type": "string", "maxLength": 300 } }, "maxConcurrency": { "title": "Legacy max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Accepted only for migration and ignored because no source is fetched." } } }, "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 } } } } } } } } } }