{ "components": { "callbacks": {}, "examples": {}, "headers": {}, "links": {}, "parameters": {}, "pathItems": {}, "requestBodies": {}, "responses": {}, "schemas": {}, "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" } } }, "info": { "description": "", "title": "Tavily", "version": "1", "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" } }, "x-aisa-catalogs": { "tavily": { "description": "", "title": "Tavily", "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" } }, "x-aisa-document": { "facts_hash": "ea2301436db90d0b30e55885326cd5057bea93ff7d26d9bced8e1ae7f1911ef4", "generator_version": "3", "protocol_version": "1", "schema_version": "1" }, "x-aisa-plans": { "builder": 1.0, "display_plan": "payg", "payg": 1.0, "similarweb_payg": 1.0, "team": 1.0, "version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb" } } }, "x-aisa-configured-paths": [ "/apis/v1/tavily/crawl", "/apis/v1/tavily/extract", "/apis/v1/tavily/map", "/apis/v1/tavily/search" ], "x-aisa-document": { "composer_version": "26", "document_hash": "sha256:4f48a7ffb2b45fe835d7f40e6dd2a81d85f52715577aeb78672892c7b3bc2955", "facts_hash": "ea2301436db90d0b30e55885326cd5057bea93ff7d26d9bced8e1ae7f1911ef4", "generator_version": "3", "protocol_version": "1", "response_pending": [], "schema_version": "1" }, "x-aisa-plans": { "builder": 1.0, "display_plan": "payg", "payg": 1.0, "similarweb_payg": 1.0, "team": 1.0, "version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb" }, "x-aisa-provider": "tavily" }, "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "openapi": "3.1.0", "paths": { "/apis/v1/tavily/crawl": { "post": { "description": "Walk a site from a root `url` and return the content of the pages it finds. Steer it with natural-language `instructions` plus regex path and domain filters, and bound it with `max_depth`, `max_breadth` and `limit`. Returns `base_url` and `results[]` with `url` and `raw_content`. Measured at about 4.5 seconds for a 3-page limit; cost and time grow with the bounds you set, so set them. Use it for broad coverage of one site — documentation, a catalogue, a competitor's blog. It answers synchronously, which `post_firecrawl_crawl` does not: that one runs as a background job and suits crawls too large to wait on. For a handful of known pages `post_tavily_extract` is far cheaper; to size a site before paying to crawl it, run `post_tavily_map` first.\n\n\n按用量计费；默认请求预估费用：$0.024 USD（不是固定价格）。 声明的单位费率：每 tavily_credit $0.008 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "post_tavily_crawl", "requestBody": { "content": { "application/json": { "schema": { "properties": { "allow_external": { "default": true, "description": "在最终结果列表中包含外部域名链接。", "type": "boolean" }, "chunks_per_source": { "default": 3, "description": "每个来源返回的相关文本块的最大数量。", "maximum": 5, "minimum": 1, "type": "integer" }, "exclude_domains": { "description": "用于从抓取中排除特定域名或子域名的正则表达式模式。", "items": { "type": "string" }, "type": "array" }, "exclude_paths": { "description": "用于排除具有特定路径模式的 URL 的正则表达式模式。", "items": { "type": "string" }, "type": "array" }, "extract_depth": { "default": "basic", "description": "提取过程的深度。", "enum": [ "basic", "advanced" ], "type": "string" }, "format": { "default": "markdown", "description": "提取的网页内容格式。", "enum": [ "markdown", "text" ], "type": "string" }, "include_favicon": { "default": false, "description": "为每个结果包含 favicon URL。", "type": "boolean" }, "include_images": { "default": false, "description": "在抓取结果中包含图片。", "type": "boolean" }, "include_usage": { "default": false, "description": "在响应中包含信用额度用量信息。", "type": "boolean" }, "instructions": { "description": "用于爬虫的自然语言指令。", "type": "string" }, "limit": { "default": 50, "description": "爬虫停止前将处理的链接总数。", "minimum": 1, "type": "integer" }, "max_breadth": { "default": 20, "description": "树中每一层可跟踪的最大链接数量。", "maximum": 500, "minimum": 1, "type": "integer" }, "max_depth": { "default": 1, "description": "最大抓取深度。", "maximum": 5, "minimum": 1, "type": "integer" }, "select_domains": { "description": "用于选择仅抓取特定域名或子域名的正则表达式模式。", "items": { "type": "string" }, "type": "array" }, "select_paths": { "description": "用于仅选择具有特定路径模式的 URL 的正则表达式模式。", "items": { "type": "string" }, "type": "array" }, "timeout": { "default": 150, "description": "等待抓取操作完成的最长时间（秒）。", "format": "float", "maximum": 150, "minimum": 10, "type": "number" }, "url": { "description": "开始抓取的根 URL。", "example": "docs.tavily.com", "type": "string" } }, "required": [ "url" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "base_url": { "description": "已抓取的基础 URL。", "type": "string" }, "request_id": { "description": "唯一请求标识符。", "type": "string" }, "response_time": { "description": "完成请求所用的时间（秒）。", "format": "float", "type": "number" }, "results": { "items": { "properties": { "favicon": { "description": "已抓取页面的 Favicon URL。", "type": "string" }, "raw_content": { "description": "从页面中提取的原始内容。", "type": "string" }, "url": { "description": "已抓取页面的 URL。", "type": "string" } }, "type": "object" }, "type": "array" }, "usage": { "properties": { "credits": { "description": "请求的额度使用详情。", "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "已成功返回抓取结果。" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Start Crawl Process", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "tavily", "x-aisa-category": "2", "x-aisa-docs-url": "https://aisa.one/docs/api-reference/search/post_tavily-crawl", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "response_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.024, "estimate_source": "profile_seed", "evidence_source": "response_body", "unit": "tavily_credit", "unit_rate_usd": 0.008 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-source": { "content_hash": "sha256:d39c6cb9a3b6cde0fb1f999983df26caed1c32f56ff0a4ac6cd61db7a89e21fe", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:81398ca500647609f3db1421d6382864a7f5fba830bdb6d35060438f730ade1a", "converter": "scripts/import_existing_contracts.py@1", "fetched_at": "2026-09-29T21:25:55+08:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:f0b5c0b8f7884e9d591f9305973b28597816793356548bf14ceb1db9ff039c36", "refresh_policy": "manual", "review_period_days": 30, "url": "https://github.com/AIsa-team/docs/blob/7783840e4710bb00886143feab84606f8aaea67c/openapi/tavily.json" } }, "x-aisa-revision": { "customer_pricing_ref": "6fdf99584383", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "1a27f6963d0e" }, "x-aisa-runtime-operation": { "method": "ANY", "operation_id": "post_tavily_crawl", "path": "/apis/v1/tavily/crawl" }, "x-aisa-source": { "content_hash": "sha256:81398ca500647609f3db1421d6382864a7f5fba830bdb6d35060438f730ade1a", "converter": "scripts/import_existing_contracts.py@1", "fetched_at": "2026-09-29T21:25:55+08:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:f0b5c0b8f7884e9d591f9305973b28597816793356548bf14ceb1db9ff039c36", "refresh_policy": "manual", "review_period_days": 30, "url": "https://github.com/AIsa-team/docs/blob/7783840e4710bb00886143feab84606f8aaea67c/openapi/tavily.json" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/crawl", "x-aisa-validation": "provider", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/tavily/crawl \\\n --header 'Authorization: Bearer ' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"url\": \"docs.tavily.com\"\n}'" } ] } }, "/apis/v1/tavily/extract": { "post": { "description": "Fetch clean, parsed content for URLs you already have — from a search result, a sitemap, or a user. `urls` is required and takes several at once. Returns `results[]` with `url`, `title`, `raw_content` and `images`, plus a `failed_results[]` array — **read that one**, because a page that could not be fetched is reported there rather than raising an error. Choose `format` (markdown or text) and `extract_depth`. Measured at about 1 second for one page. Use this instead of `post_tavily_search` whenever you can already name the pages; searching for pages you can name costs more and may not return them. For a long list that can wait, `post_firecrawl_batch_scrape` runs it as a background job. To discover the URLs of a whole site first, use `post_tavily_map`.\n\n\n按用量计费；默认请求预估费用：$0.024 USD（不是固定价格）。 声明的单位费率：每 tavily_credit $0.008 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "post_tavily_extract", "requestBody": { "content": { "application/json": { "schema": { "properties": { "chunks_per_source": { "default": 3, "description": "每个来源返回的相关内容块的最大数量。仅在提供 query 时可用。", "maximum": 5, "minimum": 1, "type": "integer" }, "extract_depth": { "default": "basic", "description": "提取过程的深度。", "enum": [ "basic", "advanced" ], "type": "string" }, "format": { "default": "markdown", "description": "提取的网页内容格式。", "enum": [ "markdown", "text" ], "type": "string" }, "include_favicon": { "default": false, "description": "为每个结果包含 favicon URL。", "type": "boolean" }, "include_images": { "default": false, "description": "包含从 URL 中提取的图片列表。", "type": "boolean" }, "include_usage": { "default": false, "description": "在响应中包含信用额度用量信息。", "type": "boolean" }, "query": { "description": "用于对提取的内容块进行重新排序的用户意图。", "type": "string" }, "timeout": { "description": "等待 URL 提取的最长时间（秒）。如果省略，默认超时时间取决于 extract_depth：basic 为 10 秒，advanced 为 30 秒。", "format": "float", "maximum": 60, "minimum": 1, "type": "number" }, "urls": { "description": "要从中提取内容的 URL。支持单个 URL 字符串和 URL 字符串数组。", "example": [ "https://en.wikipedia.org/wiki/Artificial_intelligence" ], "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] } }, "required": [ "urls" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "failed_results": { "description": "无法处理的 URL 列表。", "items": { "type": "string" }, "type": "array" }, "request_id": { "description": "唯一请求标识符。", "type": "string" }, "response_time": { "description": "完成请求所用的时间（秒）。", "format": "float", "type": "number" }, "results": { "items": { "properties": { "favicon": { "description": "所提取内容的 Favicon URL。", "type": [ "string", "null" ] }, "images": { "description": "当 include_images 为 true 时从 URL 中提取的图片。", "items": { "type": "string" }, "type": "array" }, "raw_content": { "description": "从 URL 提取的原始内容。", "type": "string" }, "title": { "description": "所提取页面的标题。", "type": "string" }, "url": { "description": "已提取内容的 URL。", "type": "string" } }, "type": "object" }, "type": "array" }, "usage": { "properties": { "credits": { "description": "请求的额度使用详情。", "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "已成功返回提取结果。" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Extract Data", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "tavily", "x-aisa-category": "2", "x-aisa-docs-url": "https://aisa.one/docs/api-reference/search/post_tavily-extract", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "response_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.024, "estimate_source": "profile_seed", "evidence_source": "response_body", "unit": "tavily_credit", "unit_rate_usd": 0.008 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-source": { "content_hash": "sha256:575b97ed182809bbc8fe1c42faf3930b43b8ee784ad88b40fe077e3ebfbd5a85", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:81398ca500647609f3db1421d6382864a7f5fba830bdb6d35060438f730ade1a", "converter": "scripts/import_existing_contracts.py@1", "fetched_at": "2026-09-29T21:25:55+08:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:f0b5c0b8f7884e9d591f9305973b28597816793356548bf14ceb1db9ff039c36", "refresh_policy": "manual", "review_period_days": 30, "url": "https://github.com/AIsa-team/docs/blob/7783840e4710bb00886143feab84606f8aaea67c/openapi/tavily.json" } }, "x-aisa-revision": { "customer_pricing_ref": "6fdf99584383", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "c0c8c25d410a" }, "x-aisa-runtime-operation": { "method": "ANY", "operation_id": "post_tavily_extract", "path": "/apis/v1/tavily/extract" }, "x-aisa-source": { "content_hash": "sha256:81398ca500647609f3db1421d6382864a7f5fba830bdb6d35060438f730ade1a", "converter": "scripts/import_existing_contracts.py@1", "fetched_at": "2026-09-29T21:25:55+08:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:f0b5c0b8f7884e9d591f9305973b28597816793356548bf14ceb1db9ff039c36", "refresh_policy": "manual", "review_period_days": 30, "url": "https://github.com/AIsa-team/docs/blob/7783840e4710bb00886143feab84606f8aaea67c/openapi/tavily.json" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/extract", "x-aisa-validation": "provider", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/tavily/extract \\\n --header 'Authorization: Bearer ' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"urls\": [\n \"https://en.wikipedia.org/wiki/Artificial_intelligence\"\n ]\n}'" } ] } }, "/apis/v1/tavily/map": { "post": { "description": "List a site's URLs from a root `url` without fetching any page content. Steer it with natural-language `instructions` and regex `select_paths` / `exclude_paths` / `select_domains` filters. Returns `base_url` and `results` — **a flat array of URL strings, not objects** — with `response_time` and `request_id`. Fast and cheap: measured at about 1.5 seconds. Use it to size a site before committing to a crawl, then fetch only the parts that matter with `post_tavily_extract`. When you want the content rather than the shape, `post_tavily_crawl` does both in one call.\n\n\n按用量计费；默认请求预估费用：$0.064 USD（不是固定价格）。 声明的单位费率：每 tavily_credit $0.008 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "post_tavily_map", "requestBody": { "content": { "application/json": { "schema": { "properties": { "allow_external": { "default": true, "description": "在最终结果列表中包含外部域名链接。", "type": "boolean" }, "exclude_domains": { "description": "用于从映射中排除特定域名或子域名的正则表达式模式。", "items": { "type": "string" }, "type": "array" }, "exclude_paths": { "description": "用于排除具有特定路径模式的 URL 的正则表达式模式。", "items": { "type": "string" }, "type": "array" }, "include_usage": { "default": false, "description": "在响应中包含信用额度用量信息。", "type": "boolean" }, "instructions": { "description": "用于爬虫的自然语言指令。", "type": "string" }, "limit": { "default": 50, "description": "爬虫停止前将处理的链接总数。", "minimum": 1, "type": "integer" }, "max_breadth": { "default": 20, "description": "树中每一层可跟踪的最大链接数量。", "maximum": 500, "minimum": 1, "type": "integer" }, "max_depth": { "default": 1, "description": "映射的最大深度。", "maximum": 5, "minimum": 1, "type": "integer" }, "select_domains": { "description": "用于选择仅抓取特定域名或子域名的正则表达式模式。", "items": { "type": "string" }, "type": "array" }, "select_paths": { "description": "用于仅选择具有特定路径模式的 URL 的正则表达式模式。", "items": { "type": "string" }, "type": "array" }, "timeout": { "default": 150, "description": "等待 map 操作完成的最长时间（秒）。", "format": "float", "maximum": 150, "minimum": 10, "type": "number" }, "url": { "description": "开始映射的根 URL。", "example": "docs.tavily.com", "type": "string" } }, "required": [ "url" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "base_url": { "description": "已映射的基础 URL。", "type": "string" }, "request_id": { "description": "唯一请求标识符。", "type": "string" }, "response_time": { "description": "完成请求所用的时间（秒）。", "format": "float", "type": "number" }, "results": { "items": { "description": "映射期间发现的 URL。", "type": "string" }, "type": "array" }, "usage": { "properties": { "credits": { "description": "请求的额度使用详情。", "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "已成功返回地图结果。" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Get Map Data", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "tavily", "x-aisa-category": "2", "x-aisa-docs-url": "https://aisa.one/docs/api-reference/search/post_tavily-map", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "response_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.064, "estimate_source": "profile_seed", "evidence_source": "response_body", "unit": "tavily_credit", "unit_rate_usd": 0.008 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-source": { "content_hash": "sha256:298acba6fc21d45fdee3f47bdfa79a4567d011c786e84cec16853f9d5bff6396", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:81398ca500647609f3db1421d6382864a7f5fba830bdb6d35060438f730ade1a", "converter": "scripts/import_existing_contracts.py@1", "fetched_at": "2026-09-29T21:25:55+08:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:f0b5c0b8f7884e9d591f9305973b28597816793356548bf14ceb1db9ff039c36", "refresh_policy": "manual", "review_period_days": 30, "url": "https://github.com/AIsa-team/docs/blob/7783840e4710bb00886143feab84606f8aaea67c/openapi/tavily.json" } }, "x-aisa-revision": { "customer_pricing_ref": "6fdf99584383", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "66f1a81c236a" }, "x-aisa-runtime-operation": { "method": "ANY", "operation_id": "post_tavily_map", "path": "/apis/v1/tavily/map" }, "x-aisa-source": { "content_hash": "sha256:81398ca500647609f3db1421d6382864a7f5fba830bdb6d35060438f730ade1a", "converter": "scripts/import_existing_contracts.py@1", "fetched_at": "2026-09-29T21:25:55+08:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:f0b5c0b8f7884e9d591f9305973b28597816793356548bf14ceb1db9ff039c36", "refresh_policy": "manual", "review_period_days": 30, "url": "https://github.com/AIsa-team/docs/blob/7783840e4710bb00886143feab84606f8aaea67c/openapi/tavily.json" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/map", "x-aisa-validation": "provider", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/tavily/map \\\n --header 'Authorization: Bearer ' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"url\": \"docs.tavily.com\"\n}'" } ] } }, "/apis/v1/tavily/search": { "post": { "description": "Search the web and get back ranked results with the page text already extracted, so there is no second call to fetch content. `query` is required. Returns `results[]` with `url`, `title`, `content` (the extracted excerpt), `score` and optionally `raw_content`, alongside `query`, `images`, `response_time` and `request_id`; set `include_answer` to also get a one-paragraph `answer`. Filter with `topic` (general/news/finance), `time_range` or explicit `start_date`/`end_date`, and trade cost against depth with `search_depth`. Measured at roughly 6 seconds for 2 results. This is the default choice for open-web research, and the only search here that returns ranked results and page text in one call. Reach past it when: you already know the URLs — `post_tavily_extract` is cheaper and exact; the query is a description rather than keywords — `post_exa_search` matches on meaning; you want a written answer rather than a list to iterate — `post_perplexity_sonar`; you want peer-reviewed papers — `post_scholar_search_scholar`.\n\n\n按用量计费；默认请求预估费用：$0.016 USD（不是固定价格）。 声明的单位费率：每 tavily_credit $0.008 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "post_tavily_search", "requestBody": { "content": { "application/json": { "schema": { "properties": { "auto_parameters": { "default": false, "description": "根据查询内容自动配置搜索参数。", "type": "boolean" }, "chunks_per_source": { "default": 3, "description": "每个来源返回的相关文本块的最大数量。", "maximum": 3, "minimum": 1, "type": "integer" }, "country": { "description": "提升特定国家/地区的搜索结果。仅当 topic 为 general 时可用。", "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" }, "end_date": { "description": "返回指定结束日期之前的结果。", "example": "2025-12-29", "format": "date", "type": "string" }, "exclude_domains": { "description": "要从搜索结果中特别排除的域名列表。", "items": { "type": "string" }, "maxItems": 150, "type": "array" }, "include_answer": { "default": false, "description": "包含由 LLM 生成的答案。true 使用默认答案模式；basic 或 advanced 用于选择答案生成模式。", "oneOf": [ { "type": "boolean" }, { "enum": [ "basic", "advanced" ], "type": "string" } ] }, "include_domains": { "description": "搜索结果中需要明确包含的域名列表。", "items": { "type": "string" }, "maxItems": 300, "type": "array" }, "include_favicon": { "default": false, "description": "为每个结果包含 favicon URL。", "type": "boolean" }, "include_image_descriptions": { "default": false, "description": "当 include_images 为 true 时，为每张图片添加描述性文本。", "type": "boolean" }, "include_images": { "default": false, "description": "执行图片搜索并包含搜索结果。", "type": "boolean" }, "include_raw_content": { "default": false, "description": "为每个搜索结果包含清理和解析后的内容。true 或 markdown 返回 Markdown；text 返回纯文本，并可能增加延迟。", "oneOf": [ { "type": "boolean" }, { "enum": [ "markdown", "text" ], "type": "string" } ] }, "include_usage": { "default": false, "description": "在响应中包含信用额度用量信息。", "type": "boolean" }, "max_results": { "default": 5, "description": "返回的最大搜索结果数。", "maximum": 20, "minimum": 0, "type": "integer" }, "query": { "description": "要使用 Tavily 执行的搜索查询。", "example": "Who is Leo Messi?", "type": "string" }, "safe_search": { "default": false, "description": "从搜索结果中过滤成人或不安全内容。仅限企业版；当 search_depth 为 fast 或 ultra-fast 时不受支持。", "type": "boolean" }, "search_depth": { "default": "basic", "description": "控制延迟与相关性之间的权衡。advanced 以更高的延迟和成本提供最高相关性；basic 实现均衡；fast 和 ultra-fast 针对更低延迟进行优化。", "enum": [ "advanced", "basic", "fast", "ultra-fast" ], "type": "string" }, "start_date": { "description": "返回指定开始日期之后的结果。", "example": "2025-02-09", "format": "date", "type": "string" }, "time_range": { "description": "根据发布日期筛选结果的时间范围。", "enum": [ "day", "week", "month", "year", "d", "w", "m", "y" ], "type": "string" }, "topic": { "default": "general", "description": "搜索类别。", "enum": [ "general", "news", "finance" ], "type": "string" } }, "required": [ "query" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "answer": { "description": "由 LLM 生成的简短回答。当 include_answer 为 false 或未生成回答时，此字段为 null。", "type": [ "string", "null" ] }, "images": { "items": { "properties": { "description": { "description": "图片描述。", "type": "string" }, "url": { "description": "图片 URL。", "type": "string" } }, "type": "object" }, "type": "array" }, "query": { "description": "已执行的搜索查询。", "type": "string" }, "request_id": { "description": "唯一请求标识符。", "type": "string" }, "response_time": { "description": "完成请求所用的时间（秒）。", "format": "float", "type": "number" }, "results": { "items": { "properties": { "content": { "description": "搜索结果的内容摘要。", "type": "string" }, "favicon": { "description": "搜索结果的 Favicon URL。", "type": [ "string", "null" ] }, "raw_content": { "description": "已清理并解析的源内容。除非请求了 include_raw_content 或没有可用的原始内容，否则为 Null。", "type": [ "string", "null" ] }, "score": { "description": "搜索结果的相关性得分。", "format": "float", "type": "number" }, "title": { "description": "搜索结果的标题。", "type": "string" }, "url": { "description": "搜索结果的 URL。", "type": "string" } }, "type": "object" }, "type": "array" }, "usage": { "properties": { "credits": { "description": "请求的额度使用详情。", "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "搜索结果已成功返回。" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Search Tavily Data", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": true }, "x-aisa-catalog-id": "tavily", "x-aisa-category": "2", "x-aisa-docs-url": "https://aisa.one/docs/api-reference/search/post_tavily-search", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "response_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.016, "estimate_source": "profile_seed", "evidence_source": "response_body", "unit": "tavily_credit", "unit_rate_usd": 0.008 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-source": { "content_hash": "sha256:b840a7f34ee5905ef50526a7906d208b0e0445f7c05fc2e74b42c893504009cf", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:81398ca500647609f3db1421d6382864a7f5fba830bdb6d35060438f730ade1a", "converter": "scripts/import_existing_contracts.py@1", "fetched_at": "2026-09-29T21:25:55+08:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:f0b5c0b8f7884e9d591f9305973b28597816793356548bf14ceb1db9ff039c36", "refresh_policy": "manual", "review_period_days": 30, "url": "https://github.com/AIsa-team/docs/blob/7783840e4710bb00886143feab84606f8aaea67c/openapi/tavily.json" } }, "x-aisa-revision": { "customer_pricing_ref": "6fdf99584383", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "4f15131e5221" }, "x-aisa-runtime-operation": { "method": "ANY", "operation_id": "post_tavily_search", "path": "/apis/v1/tavily/search" }, "x-aisa-source": { "content_hash": "sha256:81398ca500647609f3db1421d6382864a7f5fba830bdb6d35060438f730ade1a", "converter": "scripts/import_existing_contracts.py@1", "fetched_at": "2026-09-29T21:25:55+08:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:f0b5c0b8f7884e9d591f9305973b28597816793356548bf14ceb1db9ff039c36", "refresh_policy": "manual", "review_period_days": 30, "url": "https://github.com/AIsa-team/docs/blob/7783840e4710bb00886143feab84606f8aaea67c/openapi/tavily.json" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/search", "x-aisa-validation": "provider", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/tavily/search \\\n --header 'Authorization: Bearer ' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"query\": \"Who is Leo Messi?\"\n}'" } ] } } }, "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "https://api.aisa.one" } ] }