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...
| Seller | Pricing | Requests · 30d | Performance | Access |
|---|---|---|---|---|
tavilyCurrent Initiate a web mapping from a base URL · POST | $0.008–$0.016 / 10 mapped pages | — | —successP50— |
Run sends a real API request. Charges follow the published API contract.
Response structure
base_urlstringrequest_idstringresponse_timenumberresultsstring[]usageobjectcreditsinteger
// Inferred from response examples. Fields are optional and other fields may be returned.
export type ApiResponse = {
base_url?: string;
request_id?: string;
response_time?: number;
results?: Array<string>;
usage?: {
credits?: number;
};
};- Method
- POST
- Endpoint
https://api.openany.si/v1/agent-apis/tavily/map- Content type
- application/json
- Authentication
Authorization: Bearer $OPENANY_API_KEY
curl \
'https://api.openany.si/v1/agent-apis/tavily/map' \
-X POST \
-H "Authorization: Bearer $OPENANY_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"limit": 5,
"max_breadth": 5,
"max_depth": 1,
"url": "https://docs.tavily.com"
}'Input parameters
Fields in this listing; additional options and input encoding can vary by provider.
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
url | JSON request bodybody | string | Yes | The root URL to begin the mapping. |
instructions | JSON request bodybody | string | No | 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 | JSON request bodybody | integer | No | Max depth of the mapping. Defines how far from the base URL the crawler can explore. minimum: 1 · maximum: 5 |
max_breadth | JSON request bodybody | integer | No | Max number of links to follow per level of the tree (i.e., per page). minimum: 1 · maximum: 500 |
limit | JSON request bodybody | integer | No | Total number of links the crawler will process before stopping. minimum: 1 |
select_paths | JSON request bodybody | array | No | Regex patterns to select only URLs with specific path patterns (e.g., `/docs/.*`, `/api/v1.*`).Nested fields and variants
|
select_domains | JSON request bodybody | array | No | Regex patterns to select crawling to specific domains or subdomains (e.g., `^docs\.example\.com$`).Nested fields and variants
|
exclude_paths | JSON request bodybody | array | No | Regex patterns to exclude URLs with specific path patterns (e.g., `/private/.*`, `/admin/.*`).Nested fields and variants
|
exclude_domains | JSON request bodybody | array | No | Regex patterns to exclude specific domains or subdomains from crawling (e.g., `^private\.example\.com$`).Nested fields and variants
|
allow_external | JSON request bodybody | boolean | No | Whether to include external domain links in the final results list. |
Required markers inside a nested object or variant apply when that object or variant is used.
Sample response
Response template · not a real response · Configured HTTP 200; actual status is unverified. Response illustration only. Placeholder values and unknown business fields are not recorded API results. Replace request placeholders before use.
{
"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
}
}Usage billing
The displayed rate follows the published options and billing groups. Final charges follow reported usage.
Agent integration
Copy the resource contract without sharing an API key.
View API Markdown
# 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.
## Available implementations
tavily · Initiate a web mapping from a base URL: https://openany.si/markets/apis/capabilities/web-initiate-a-web-mapping-from-a-base-url?offering=e5ad342e-f0c5-40fa-ab51-131c28671286 · $0.008–$0.016 / 10 mapped pages
## Selected API contract
Documentation: https://openany.si/markets/apis/capabilities/web-initiate-a-web-mapping-from-a-base-url
Method: POST
Endpoint: https://api.openany.si/v1/agent-apis/tavily/map
Price: $0.008–$0.016 / 10 mapped pages
Pricing note: The displayed rate follows the published options and billing groups. Final charges follow reported usage.
Provider: tavily
Contract revision: 3
Price source: OpenAny public API contract and documented provider unit rates. Price update time: not supplied.
Use OPENANY_API_KEY from the environment. API Key calls use your shared balance.
## Prepared request
```bash
curl \
'https://api.openany.si/v1/agent-apis/tavily/map' \
-X POST \
-H "Authorization: Bearer $OPENANY_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"limit": 5,
"max_breadth": 5,
"max_depth": 1,
"url": "https://docs.tavily.com"
}'
```
## API contract
```json
{
"resource_type": "api",
"name": "Initiate a web mapping from a base URL",
"endpoint": "https://api.openany.si/v1/agent-apis/tavily/map",
"method": "POST",
"content_type": "application/json",
"execution_mode": "sync",
"authentication": {
"type": "bearer",
"environment_variable": "OPENANY_API_KEY"
},
"inputs": [
{
"description": "The root URL to begin the mapping.",
"location": "body",
"name": "url",
"nullable": false,
"pointer": "/url",
"required": true,
"type": "string"
},
{
"description": "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.",
"location": "body",
"name": "instructions",
"nullable": false,
"pointer": "/instructions",
"required": false,
"type": "string"
},
{
"description": "Max depth of the mapping. Defines how far from the base URL the crawler can explore.",
"location": "body",
"maximum": "5",
"minimum": "1",
"name": "max_depth",
"nullable": false,
"pointer": "/max_depth",
"required": false,
"type": "integer"
},
{
"description": "Max number of links to follow per level of the tree (i.e., per page).",
"location": "body",
"maximum": "500",
"minimum": "1",
"name": "max_breadth",
"nullable": false,
"pointer": "/max_breadth",
"required": false,
"type": "integer"
},
{
"description": "Total number of links the crawler will process before stopping.",
"location": "body",
"minimum": "1",
"name": "limit",
"nullable": false,
"pointer": "/limit",
"required": false,
"type": "integer"
},
{
"description": "Regex patterns to select only URLs with specific path patterns (e.g., `/docs/.*`, `/api/v1.*`).",
"item_type": "string",
"location": "body",
"name": "select_paths",
"nullable": false,
"pointer": "/select_paths",
"required": false,
"type": "array"
},
{
"description": "Regex patterns to select crawling to specific domains or subdomains (e.g., `^docs\\.example\\.com$`).",
"item_type": "string",
"location": "body",
"name": "select_domains",
"nullable": false,
"pointer": "/select_domains",
"required": false,
"type": "array"
},
{
"description": "Regex patterns to exclude URLs with specific path patterns (e.g., `/private/.*`, `/admin/.*`).",
"item_type": "string",
"location": "body",
"name": "exclude_paths",
"nullable": false,
"pointer": "/exclude_paths",
"required": false,
"type": "array"
},
{
"description": "Regex patterns to exclude specific domains or subdomains from crawling (e.g., `^private\\.example\\.com$`).",
"item_type": "string",
"location": "body",
"name": "exclude_domains",
"nullable": false,
"pointer": "/exclude_domains",
"required": false,
"type": "array"
},
{
"description": "Whether to include external domain links in the final results list.",
"location": "body",
"name": "allow_external",
"nullable": false,
"pointer": "/allow_external",
"required": false,
"type": "boolean"
}
],
"billing": {
"currency": "USD",
"mode": "usage",
"priceMicroUsd": "8000",
"rounding": "ceil",
"unit": "credit",
"unitQuantity": "1"
},
"examples": [
{
"http_status": 200,
"name": "Schema template · Basic request (HTTP assumed)",
"request": {
"body": {
"limit": 5,
"max_breadth": 5,
"max_depth": 1,
"url": "https://docs.tavily.com"
},
"headers": {},
"path": {},
"query": {}
},
"response_body": {
"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
}
}
},
{
"http_status": 200,
"name": "Schema template · Select documentation paths (HTTP assumed)",
"request": {
"body": {
"limit": 5,
"max_breadth": 5,
"max_depth": 1,
"select_paths": [
"/documentation/.*"
],
"url": "https://docs.tavily.com"
},
"headers": {},
"path": {},
"query": {}
},
"response_body": {
"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
}
}
}
]
}
```Error handling
| Status | Next step |
|---|---|
400 | Check the offering and request fields. |
401 / 403 | Verify your credentials and access permissions. |
402 | Inspect the selected access mode and returned payment requirements. |
429 | Respect the returned rate limit and retry guidance. |
5xx | Inspect the error and usage record before retrying a paid operation. |
Schema template · Basic request (HTTP assumed)
Response illustration only. Placeholder values and unknown business fields are not recorded API results. Replace request placeholders before use.
Prepare your environment
Use a terminal with cURL installed.
Use an OpenAny API key with shared-balance access. Confirm availability and price before running; a call may charge your balance.
Set the key in your terminal using the hidden prompt below. Keep its value out of source files and logs.
Terminal · macOS / Linuxprintf 'OpenAny API key: ' read -r -s OPENANY_API_KEY export OPENANY_API_KEY printf '\n'Run the request
Paste the complete command below into your terminal.
Values to replace before running 10
Review these request fields before running. Keep the published provider and request method unchanged.
url- The root URL to begin the mapping.
instructions- 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- Max depth of the mapping. Defines how far from the base URL the crawler can explore.
max_breadth- Max number of links to follow per level of the tree (i.e., per page).
limit- Total number of links the crawler will process before stopping.
select_paths- Regex patterns to select only URLs with specific path patterns (e.g., `/docs/.*`, `/api/v1.*`).
select_domains- Regex patterns to select crawling to specific domains or subdomains (e.g., `^docs\.example\.com$`).
exclude_paths- Regex patterns to exclude URLs with specific path patterns (e.g., `/private/.*`, `/admin/.*`).
exclude_domains- Regex patterns to exclude specific domains or subdomains from crawling (e.g., `^private\.example\.com$`).
allow_external- Whether to include external domain links in the final results list.
Terminal · cURLcurl \ 'https://api.openany.si/v1/agent-apis/tavily/map' \ -X POST \ -H "Authorization: Bearer $OPENANY_API_KEY" \ -H 'Content-Type: application/json' \ --data-raw '{ "limit": 5, "max_breadth": 5, "max_depth": 1, "url": "https://docs.tavily.com" }'Check the response
Response template · not a real response · Configured HTTP 200; actual status is unverified.
Response template · not a real 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 } }
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.