What you get#
Onekey exposes Tavily as 4 endpoints behind one API key: 4 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Tavily also works for the rest of the ai & search category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
crawl | Crawl a website from a root URL and return the content of up to 10 pages. | url* | 2 | beta |
extract | Clean markdown content extracted from a web page. | url* | 2 | beta |
map | Discover the pages of a website (a site graph from a root URL, up to 10 pages). | url* | 2 | beta |
search | Tavily AI search: ranked results with content extracts. | q* | 5 | beta |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls tavily.crawl (2 credits, beta). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/tavily/crawl?url=https%3A%2F%2Fdocs.tavily.com" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Tavily, with the same names as on every other platform. The count is how many of its 4 mapped endpoints return the field; a field the source lacks is null, never missing.
| Field | Type | Endpoints |
|---|---|---|
content.url | URL | 4 |
content.text | string | 3 |
content.title | string | 1 |
entity.stats.score | number | 1 |
media.thumbnailUrl | URL | 1 |
The full schema is in Unified schema.
Pricing#
Tavily calls cost 2 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.