> ## Documentation Index
> Fetch the complete documentation index at: https://docs.novita.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Tavily Map

Tavily is a web data retrieval API designed for developers and AI applications. This document describes the Tavily passthrough endpoints exposed by the platform gateway. It is based on Tavily's Map API with platform route prefixes applied.

Base URL example: `https://api.novita.ai`

Map a site starting from a root URL, following links to discover the structure of reachable pages and return their URLs.

## Request Headers

All endpoints require platform API authentication.

**Content-Type** `string` *required*

Use `application/json`.

**Authorization** `string` *required*

Platform API key, formatted as `Bearer <api_key>`.

## Request Body

**url** `string` *required*

Crawl root URL.

**instructions** `string`

Crawler instructions in natural language.

**max\_depth** `integer`

Crawler depth limit. Default is `1`; range is `1` to `5`.

**max\_breadth** `integer`

Max links per page. Default is `20`; range is `1` to `500`.

**limit** `integer`

Link processing limit for crawler. Default is `50`; minimum is `1`.

**select\_paths** `string[]`

Restrict URL paths matching these regex patterns.

**select\_domains** `string[]`

Restrict domains matching these regex patterns.

**exclude\_paths** `string[]`

Exclude URL paths matching these regex patterns.

**exclude\_domains** `string[]`

Exclude domains matching these regex patterns.

**allow\_external** `boolean`

Include external domain links.

**timeout** `float`

Crawl operation time limit in seconds. Default is `150`; range is `10` to `150`.

## Request Example

```bash theme={"system"}
curl -s -X POST 'https://api.novita.ai/v3/tavily/map' \
  -H 'Authorization: Bearer sk-123' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "docs.tavily.com",
    "instructions": "Find all pages about the Python SDK",
    "max_depth": 2,
    "max_breadth": 20,
    "limit": 50,
    "select_paths": ["/docs/.*"],
    "exclude_paths": ["/admin/.*"],
    "allow_external": false,
    "timeout": 60
  }'
```

## Response

**base\_url** `string`

Crawl base URL.

**results** `string[]`

URLs discovered during mapping.

**response\_time** `float`

Request duration in seconds.

**request\_id** `string`

Unique request identifier.

## Errors

The platform may return standard HTTP errors before forwarding the request, and Tavily may return upstream errors after forwarding.

**400** `status`

Invalid request body or unsupported parameter value.

**401** `status`

Missing or invalid API key.

**403** `status`

Access denied by platform or upstream provider, or the URL is not supported.

**404** `status`

Route or requested resource not found.

**429** `status`

Rate limit exceeded.

**500** `status`

Internal server error.

**502** `status`

Upstream provider error.

**503** `status`

Service unavailable.

## Notes

* All request bodies are JSON.
* Extra Tavily parameters not listed here may be passed through.
* Response shapes can vary depending on request options.
* This document intentionally omits billing-related fields.

## References

For more details, see the [Tavily Map API reference](https://docs.tavily.com/documentation/api-reference/endpoint/map).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.