Initiate a web mapping from a base URL

Retrieve initiate a web mapping from a base URL via API. Supply a URL. Sample fields include results. Use the result as input for a related analysis or application. The POST request schema also lists instructions, max_depth.

Selected price
$0.008–$0.016 / 10 mapped pagesPublished pricing
Sellers / implementations
1 / 1
Requests · 30d
—Loading...
Success rate · 30d
—Loading...

Run sends a real API request. Charges follow the published API contract.

Request parameters
The root URL to begin the mapping.
Optional parameters (9)
Natural language instructions for the crawler. When specified, the cost increases to 2 API credits per 10 successful pages instead of 1 API credit per 10 pages.
Max depth of the mapping. Defines how far from the base URL the crawler can explore.
Max number of links to follow per level of the tree (i.e., per page).
Total number of links the crawler will process before stopping.
select_paths array
Regex patterns to select only URLs with specific path patterns (e.g., `/docs/.*`, `/api/v1.*`).
select_domains array
Regex patterns to select crawling to specific domains or subdomains (e.g., `^docs\.example\.com$`).
exclude_paths array
Regex patterns to exclude URLs with specific path patterns (e.g., `/private/.*`, `/admin/.*`).
exclude_domains array
Regex patterns to exclude specific domains or subdomains from crawling (e.g., `^private\.example\.com$`).
Whether to include external domain links in the final results list.

Sample response

{
  "base_url": "docs.tavily.com",
  "request_id": "123e4567-e89b-12d3-a456-426614174111",
  "response_time": 1.23,
  "results": [
    "https://docs.tavily.com/welcome",
    "https://docs.tavily.com/documentation/api-credits",
    "https://docs.tavily.com/documentation/about"
  ],
  "usage": {
    "credits": 1
  }
}

Response result

Response structure

Inferred from examples
  • base_urlstring
  • request_idstring
  • response_timenumber
  • resultsstring[]
  • usageobject
    • creditsinteger

Common questions

Do I need a separate key for every provider?

Use your OpenAny API key for standard API access. Read it from OPENANY_API_KEY in your environment and keep it out of prompts, source code and logs.

Are these providers interchangeable?

No. Each offering has its own inputs, pricing and response contract. Selecting a catalog offering does not establish automatic routing or fallback. Confirm the service contract before calling.

How is this API billed?

API-key calls use your shared balance at the selected implementation's published rate. Check the billing unit and request-specific pricing rules before making a paid call. Recorded usage determines the final charge under that contract.

Where do the price and contract come from?

The selected implementation publishes its provider, request contract, revision and billing rules through OpenAny's public API catalog. A revision number identifies a contract version, not a price update date. A price update timestamp is not supplied; do not treat a page date as one.

How do OpenAny Balance and x402 differ?

OpenAny Balance uses an API key and one shared balance. Card, USDC and x402 top-ups, card auto top-up and USDC subscriptions fund that balance; available routes appear on the Credits page. Direct x402 is a separate pay-per-request flow, available only on listings that show it and requiring an authorized payment client.

Does Playground send a paid request?

Yes. After you sign in, Run sends a real API request using an active OpenAny API key. Charges follow the published API contract and use your shared balance. Selecting an implementation, editing inputs and viewing sample responses do not send requests.

Use Initiate a web mapping from a base URL with your agent

Inspect endpoint contracts and confirm availability and pricing before a paid call.