{ "openapi": "3.0.1", "info": { "title": "Reconciliation Service Extractor (OpenRefine / W3C)", "description": "Point at ANY W3C Reconciliation (OpenRefine) service and pull results: fetch the capability manifest, batch-match query strings to candidate entities with scores, autocomplete (suggest), and fetch property values (extend). Works with Wikidata, GND, Getty and any conforming endpoint.", "version": "0.1", "x-build-id": "VHlIwnnOjBf6YUcBh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datamule~reconciliation-service-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datamule-reconciliation-service-extractor", "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/datamule~reconciliation-service-extractor/runs": { "post": { "operationId": "runs-sync-datamule-reconciliation-service-extractor", "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/datamule~reconciliation-service-extractor/run-sync": { "post": { "operationId": "run-sync-datamule-reconciliation-service-extractor", "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": [ "endpoint" ], "properties": { "endpoint": { "title": "Reconciliation endpoint URL", "type": "string", "description": "The base URL of ANY W3C Reconciliation Service API (the OpenRefine reconciliation spec). Fetching this URL returns the service manifest. Examples: https://wikidata.reconci.link/en/api , https://lobid.org/gnd/reconcile , https://services.getty.edu/vocab/reconcile/" }, "modes": { "title": "Modes", "type": "array", "description": "Which operations to run. 'manifest' fetches the service capability manifest (cheap connectivity probe). 'reconcile' batch-matches your query strings to candidate entities. 'suggest' autocompletes (only if the service advertises it). 'extend' fetches property values for ids (only if advertised).", "items": { "type": "string", "enum": [ "manifest", "reconcile", "suggest", "extend" ], "enumTitles": [ "Manifest (service capabilities)", "Reconcile (match query strings)", "Suggest (autocomplete)", "Extend (property values for ids)" ] }, "default": [ "manifest", "reconcile" ] }, "queries": { "title": "Queries to reconcile", "type": "array", "description": "For 'reconcile' mode: the list of strings to match against the service (person names, place names, subject terms, etc). Each query yields one row per candidate match.", "items": { "type": "string" } }, "typeFilter": { "title": "Type filter (optional)", "type": "string", "description": "Optional entity type id to constrain reconcile candidates (e.g. a Wikidata Q-id like Q5 for humans, or a service-specific type from the manifest's defaultTypes). Leave blank to search all types." }, "limit": { "title": "Candidates per query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum candidate matches to return per query (and per suggest call). Leave blank for the service default.", "default": 5 }, "suggestFlavour": { "title": "Suggest flavour", "enum": [ "entity", "property", "type" ], "type": "string", "description": "For 'suggest' mode: what to autocomplete.", "default": "entity" }, "suggestPrefix": { "title": "Suggest prefix", "type": "string", "description": "For 'suggest' mode: the text prefix to autocomplete (e.g. 'Einst')." }, "extendIds": { "title": "Extend: entity ids", "type": "array", "description": "For 'extend' mode: the entity ids whose property values you want (e.g. ['Q937']). Get these from a prior reconcile run.", "items": { "type": "string" } }, "extendProperties": { "title": "Extend: property ids", "type": "array", "description": "For 'extend' mode: the property ids to fetch for each entity (e.g. ['P569','P19'] on Wikidata for birth date / birth place).", "items": { "type": "string" } } } }, "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 } } } } } } } } } }