# Tavily-compatible API (/en/docs/api/compatible/tavily)



## Base URL [#base-url]

<ApiBaseDomain prefix="/tavily" />

## Get started [#get-started]

<QuickstartTabs snippets="{&#x22;curl&#x22;:&#x22;curl https://api-origin.invalid/tavily/search \\\n  -H \&#x22;Authorization: Bearer $PRAXIS_API_KEY\&#x22; \\\n  -H \&#x22;Content-Type: application/json\&#x22; \\\n  -d '{\&#x22;query\&#x22;:\&#x22;Who is Leo Messi?\&#x22;}'&#x22;,&#x22;python&#x22;:&#x22;import os\n\nfrom tavily import TavilyClient\n\ntavily_client = TavilyClient(\n    api_key=os.environ[\&#x22;PRAXIS_API_KEY\&#x22;],\n    api_base_url=\&#x22;https://api-origin.invalid/tavily\&#x22;,\n)\n\nresponse = tavily_client.search(\&#x22;Who is Leo Messi?\&#x22;)\nprint(response)&#x22;,&#x22;typescript&#x22;:&#x22;import { tavily } from \&#x22;@tavily/core\&#x22;;\n\nconst tvly = tavily({\n  apiKey: process.env.PRAXIS_API_KEY,\n  apiBaseURL: \&#x22;https://api-origin.invalid/tavily\&#x22;,\n});\n\nconst response = await tvly.search(\&#x22;Who is Leo Messi?\&#x22;);\nconsole.log(response);&#x22;}" />

## Endpoints [#endpoints]

| Method | Path                                                | Description     | Support     |
| ------ | --------------------------------------------------- | --------------- | ----------- |
| POST   | [`/search`](/docs/api/compatible/tavily/search)     | Search          | ● Supported |
| POST   | [`/extract`](/docs/api/compatible/tavily/extract)   | Extract         | ● Supported |
| POST   | [`/crawl`](/docs/api/compatible/tavily/crawl)       | Crawl           | ● Supported |
| POST   | [`/map`](/docs/api/compatible/tavily/map)           | Map             | ● Supported |
| POST   | [`/feedback`](/docs/api/compatible/tavily/feedback) | Submit feedback | ● Supported |

## Differences from Tavily [#differences-from-tavily]

* <a href="/docs/api/compatible/tavily/crawl">Crawl</a>：Your account balance must be above 0 before the call. Billed by the usage.credits Tavily returns, $0.01 per credit; when Tavily reports no usage, the call is billed at the most it could have consumed.
* <a href="/docs/api/compatible/tavily/map">Map</a>：Your account balance must be above 0 before the call. Billed by the usage.credits Tavily returns, $0.01 per credit; when Tavily reports no usage, the call is billed at the most it could have consumed.
* <a href="/docs/api/compatible/tavily/feedback">Submit feedback</a>：Forwarded to Tavily as is and not billed (Tavily's own pricing does not charge for feedback).

For authoritative parameter definitions, see the [official Tavily documentation](https://docs.tavily.com/documentation/api-reference).

Errors follow the Tavily format, see [errors](/docs/api/errors); quotas and response headers are covered in [rate limits](/docs/api/rate-limits).