Skip to main content
POST
Extract web page content from specified URLs using Tavily Extract.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
urls
required

The URL or URLs to extract content from. A single URL string and an array of URL strings are both accepted.

Example:
query
string

User intent for reranking extracted content chunks.

chunks_per_source
integer
default:3

Maximum number of relevant chunks returned per source. Available only when query is provided.

Required range: 1 <= x <= 5
extract_depth
enum<string>
default:basic

Depth of the extraction process.

Available options:
basic,
advanced
include_images
boolean
default:false

Include a list of images extracted from the URLs.

include_favicon
boolean
default:false

Include the favicon URL for each result.

format
enum<string>
default:markdown

Format of the extracted web page content.

Available options:
markdown,
text
timeout
number<float>

Maximum time in seconds to wait for URL extraction. If omitted, default timeouts depend on extract_depth: 10 seconds for basic and 30 seconds for advanced.

Required range: 1 <= x <= 60
include_usage
boolean
default:false

Include credit usage information in the response.

Response

200 - application/json

Extraction results returned successfully.

results
object[]
failed_results
string[]

List of URLs that could not be processed.

response_time
number<float>

Time in seconds it took to complete the request.

usage
object
request_id
string

Unique request identifier.