Quickstart

Use @tavily/core to call Tavily Search, Extract, and Crawl from your JavaScript and TypeScript programs. For every method and parameter, see the JavaScript SDK reference.

Get an API key

Get a free Tavily API key. You get 1,000 free API credits every month, and no credit card is required.

Install the SDK

npm i @tavily/core

Make your first search

const { tavily } = require("@tavily/core");

const tvly = tavily({ apiKey: "tvly-YOUR_API_KEY" });
const response = await tvly.search("Who is Leo Messi?");

console.log(response);

More examples

Extract content from URLs:

const { tavily } = require("@tavily/core");

const tvly = tavily({ apiKey: "tvly-YOUR_API_KEY" });
const response = await tvly.extract(
  "https://en.wikipedia.org/wiki/Lionel_Messi"
);

console.log(response);

Run a smart crawl starting at a given URL:

const { tavily } = require("@tavily/core");

const tvly = tavily({ apiKey: "tvly-YOUR_API_KEY" });
const response = await tvly.crawl("https://docs.tavily.com", { instructions: "Find all pages on the Python SDK" });

console.log(response);

Features

Our JavaScript SDK supports the full feature range of our REST API. Our JavaScript client is asynchronous by default.

The search function lets you harness the full power of Tavily Search.
The extract function allows you to easily retrieve web content with Tavily Extract.

Resources

GitHub

/tavily-ai/tavily-js

NPM

@tavily/core npm downloads

Get started

Coding agents

API keys & credits

Best practices

Help

More examples

Features

Resources

GitHub

NPM

​More examples

​Features

​Resources

GitHub

NPM

More examples

Features

Resources