{ "openapi": "3.0.1", "info": { "title": "AI Search Tool - Real-Time Web Search", "description": "Give your AI agents real-world knowledge.\n\nThis Actor provides high-quality web, news, image, video, and book search results using a multi-backend DuckDuckGo–powered infrastructure, with automatic fallbacks to Brave, Bing, Yahoo, Google (where available).", "version": "1.0", "x-build-id": "D9OHaD9rsCKTT4uJj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~ai-web-search-tool/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-ai-web-search-tool", "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/abotapi~ai-web-search-tool/runs": { "post": { "operationId": "runs-sync-abotapi-ai-web-search-tool", "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/abotapi~ai-web-search-tool/run-sync": { "post": { "operationId": "run-sync-abotapi-ai-web-search-tool", "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": { "resultType": { "title": "Result Type", "enum": [ "web", "images", "videos", "news", "books" ], "type": "string", "description": "Type of search results to scrape: web, images, videos, news or books. Alias: searchMode (default = web).", "default": "web" }, "query": { "title": "Search Query", "type": "string", "description": "The search query to scrape results for. Alias: search.", "default": "Tesla" }, "searchMode": { "title": "Search mode (alias of Result Type)", "enum": [ "default", "web", "images", "news", "videos", "books" ], "type": "string", "description": "Alias of resultType: default (same as web), web, images, news, videos or books. Used when Result Type is left at web." }, "search": { "title": "Search (alias of Search Query)", "type": "string", "description": "Alias of query, accepted so inputs written for other DuckDuckGo scrapers work unchanged. Used when Search Query is left at its default." }, "region": { "title": "Region", "type": "string", "description": "Region/language code for search results. Free text so saved tasks keep working; unknown codes are used but logged as a warning. Known codes: wt-wt (no region), ar-es, au-en, at-de, be-fr, be-nl, br-pt, bg-bg, ca-en, ca-fr, ct-ca, cl-es, cn-zh, co-es, hr-hr, cz-cs, dk-da, ee-et, fi-fi, fr-fr, de-de, gr-el, hk-tzh, hu-hu, in-en, id-en, ie-en, il-en, it-it, jp-jp, kr-kr, lv-lv, lt-lt, my-en, mx-es, nl-nl, nz-en, no-no, pk-en, pe-es, ph-en, pl-pl, pt-pt, ro-ro, ru-ru, xa-ar, sg-en, sk-sk, sl-sl, za-en, es-ca, es-es, se-sv, ch-de, ch-fr, tw-tzh, th-en, tr-tr, us-en, us-es, ua-uk, uk-en, vn-en", "default": "us-en" }, "safeSearch": { "title": "Safe Search", "enum": [ "off", "moderate", "strict", "OFF", "MODERATE", "STRICT" ], "type": "string", "description": "Safe search filter level (case-insensitive: off/OFF, moderate/MODERATE, strict/STRICT)", "default": "moderate" }, "timeRange": { "title": "Time Range", "enum": [ "", "d", "w", "m", "y" ], "type": "string", "description": "Filter results by time range (optional)", "default": "" }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of search results to scrape (1-500). Alias: maxItems.", "default": 50 }, "maxItems": { "title": "Max items (alias of Maximum Results)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Alias of maxResults. Used when Maximum Results is left at its default." }, "endPage": { "title": "End page", "minimum": 1, "maximum": 50, "type": "integer", "description": "Stop after this many result pages (about 10 results per page). Caps the result count at endPage x 10." }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Apify Proxy (automatic datacenter, escalating when needed) works out of the box; you can also supply your own proxy URLs." }, "dev_transform_fields": { "title": "Transform Fields (Advanced)", "type": "array", "description": "Transform output to include only specified fields. Use dot notation for nested objects.", "items": { "type": "string" }, "default": [] }, "dev_dataset_name": { "title": "Custom Dataset Name (Advanced)", "type": "string", "description": "Save results into a custom named Dataset. Placeholders: {ACTOR}, {DATE}, {TIME}", "default": "default" }, "dev_dataset_clear": { "title": "Clear Dataset Before Insert (Advanced)", "type": "boolean", "description": "Clear the dataset before inserting new data", "default": false }, "mcpConnectors": { "title": "Pipe results into your apps (optional)", "type": "array", "description": "Optionally send results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize one under Apify, Settings, API & Integrations, then select it here. Notion gets a rich page-per-item export; other connectors get a best-effort write or digest. Leave empty to skip; never changes the dataset output.", "items": { "type": "string" } }, "notionParentPageUrl": { "title": "Notion parent page (Notion connector only)", "type": "string", "description": "URL or id of the Notion page under which search-result pages are created. Required to enable the Notion export; ignored by other connectors." }, "maxNotifyListings": { "title": "Max results to export per connector", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on results written to each connector per run. Does not affect the dataset.", "default": 50 } } }, "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 } } } } } } } } } }