# Tavily on Onekey

> 4 endpoints for Tavily (0 stable, 4 beta), 2 to 5 credits each. Category: AI & search. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/tavily
Reference (Markdown): https://onekey.dev/docs/api/tavily.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 4 mapped Tavily endpoints return each:

- `content.url` (URL): 4
- `content.text` (string): 3
- `content.title` (string): 1
- `entity.stats.score` (number): 1
- `media.thumbnailUrl` (URL): 1

## Endpoints

### tavily.crawl

Crawl a website from a root URL and return the content of up to 10 pages.
- Price: 2 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/tavily/crawl?url=https%3A%2F%2Fdocs.tavily.com` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, required): Root URL of the site to crawl
- Fields returned: `content.url`, `content.text`
- Reference: https://onekey.dev/docs/api/tavily/crawl.md

### tavily.extract

Clean markdown content extracted from a web page.
- Price: 2 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/tavily/extract?url=https%3A%2F%2Fdocs.tavily.com` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, required): Public URL of the page to extract
- Fields returned: `content.url`, `content.text`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/tavily/extract.md

### tavily.map

Discover the pages of a website (a site graph from a root URL, up to 10 pages).
- Price: 2 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/tavily/map?url=https%3A%2F%2Fdocs.tavily.com` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, required): Root URL of the site to map
- Fields returned: `content.url`
- Reference: https://onekey.dev/docs/api/tavily/map.md

### tavily.search

Tavily AI search: ranked results with content extracts.
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/tavily/search?q=python` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `content.title`, `content.url`, `content.text`, `entity.stats.score`
- Reference: https://onekey.dev/docs/api/tavily/search.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/tavily/crawl?url=https%3A%2F%2Fdocs.tavily.com" \
  -H "x-api-key: YOUR_API_KEY"
```