{ "openapi": "3.0.1", "info": { "title": "Tavily Search API - AI Web Search, No API Key Needed", "description": "Search the web with Tavily's AI engine, no API key or account needed. Get ranked results, AI-generated answers, images, and full page content. Supports 4 search depths, date filtering, domain restrictions, country boosting, and news search. Export to JSON, CSV, or Excel.", "version": "0.0", "x-build-id": "F0Juh0YtcOyscscFE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clearpath~tavily-search-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clearpath-tavily-search-api", "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/clearpath~tavily-search-api/runs": { "post": { "operationId": "runs-sync-clearpath-tavily-search-api", "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/clearpath~tavily-search-api/run-sync": { "post": { "operationId": "run-sync-clearpath-tavily-search-api", "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": [ "query" ], "properties": { "query": { "title": "Search query", "type": "string", "description": "Use quotes for exact phrases, e.g. \"machine learning\" tutorials" }, "searchDepth": { "title": "Search depth (speed vs. relevance)", "enum": [ "ultra-fast", "fast", "basic", "advanced" ], "type": "string", "description": "Advanced unlocks the Chunks per source option.", "default": "basic" }, "maxResults": { "title": "Max results (1–20)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of search results to return.", "default": 5 }, "topic": { "title": "Topic", "enum": [ "general", "news" ], "type": "string", "description": "Country filter only works with General.", "default": "general" }, "includeAnswer": { "title": "AI-generated answer", "enum": [ "false", "basic", "advanced" ], "type": "string", "description": "LLM-synthesized answer from search results.", "default": "false" }, "timeRange": { "title": "Time range", "enum": [ "day", "week", "month", "year" ], "type": "string", "description": "For exact date ranges, use Start/End date instead." }, "startDate": { "title": "Start date (results after this date)", "type": "string", "description": "Format: YYYY-MM-DD" }, "endDate": { "title": "End date (results before this date)", "type": "string", "description": "Format: YYYY-MM-DD" }, "exactMatch": { "title": "Exact phrase match only", "type": "boolean", "description": "Only return results containing the exact query phrase. Bypasses synonyms and semantic variations.", "default": false }, "includeDomains": { "title": "Only search these domains", "type": "array", "description": "Without https://, e.g. reddit.com, github.com. Max 300.", "items": { "type": "string" } }, "excludeDomains": { "title": "Exclude these domains", "type": "array", "description": "Without https://, e.g. pinterest.com, quora.com. Max 150.", "items": { "type": "string" } }, "country": { "title": "Country (boost results from)", "enum": [ "afghanistan", "albania", "algeria", "andorra", "angola", "argentina", "armenia", "australia", "austria", "azerbaijan", "bahamas", "bahrain", "bangladesh", "barbados", "belarus", "belgium", "belize", "benin", "bhutan", "bolivia", "bosnia and herzegovina", "botswana", "brazil", "brunei", "bulgaria", "burkina faso", "burundi", "cambodia", "cameroon", "canada", "cape verde", "central african republic", "chad", "chile", "china", "colombia", "comoros", "congo", "costa rica", "croatia", "cuba", "cyprus", "czech republic", "denmark", "djibouti", "dominican republic", "ecuador", "egypt", "el salvador", "equatorial guinea", "eritrea", "estonia", "ethiopia", "fiji", "finland", "france", "gabon", "gambia", "georgia", "germany", "ghana", "greece", "guatemala", "guinea", "haiti", "honduras", "hungary", "iceland", "india", "indonesia", "iran", "iraq", "ireland", "israel", "italy", "jamaica", "japan", "jordan", "kazakhstan", "kenya", "kuwait", "kyrgyzstan", "latvia", "lebanon", "lesotho", "liberia", "libya", "liechtenstein", "lithuania", "luxembourg", "madagascar", "malawi", "malaysia", "maldives", "mali", "malta", "mauritania", "mauritius", "mexico", "moldova", "monaco", "mongolia", "montenegro", "morocco", "mozambique", "myanmar", "namibia", "nepal", "netherlands", "new zealand", "nicaragua", "niger", "nigeria", "north korea", "north macedonia", "norway", "oman", "pakistan", "panama", "papua new guinea", "paraguay", "peru", "philippines", "poland", "portugal", "qatar", "romania", "russia", "rwanda", "saudi arabia", "senegal", "serbia", "singapore", "slovakia", "slovenia", "somalia", "south africa", "south korea", "south sudan", "spain", "sri lanka", "sudan", "sweden", "switzerland", "syria", "taiwan", "tajikistan", "tanzania", "thailand", "togo", "trinidad and tobago", "tunisia", "turkey", "turkmenistan", "uganda", "ukraine", "united arab emirates", "united kingdom", "united states", "uruguay", "uzbekistan", "venezuela", "vietnam", "yemen", "zambia", "zimbabwe" ], "type": "string", "description": "General topic only." }, "includeRawContent": { "title": "Full page content", "enum": [ "false", "markdown", "text" ], "type": "string", "description": "Parsed page content in each result's raw_content field. Increases output size.", "default": "false" }, "includeImages": { "title": "Include image results", "type": "boolean", "description": "Adds an images array with URL, title, and optional description.", "default": false }, "includeImageDescriptions": { "title": "Add AI descriptions to images", "type": "boolean", "description": "Requires Include image results to be enabled.", "default": false }, "chunksPerSource": { "title": "Chunks per source (1–3, Advanced only)", "minimum": 1, "maximum": 3, "type": "integer", "description": "Content snippets (max 500 chars each) per source. Controls the content field length.", "default": 3 } } }, "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 } } } } } } } } } }