Map

Request body

• urlstring必填

  The root URL to begin the mapping.

• limitinteger可选
  默认 50

  Total number of links the crawler will process before stopping.

• instructionsstring可选
  默认 null

  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_depthinteger可选
  默认 1

  Max depth of the mapping. Defines how far from the base URL the crawler can explore.

• max_breadthinteger可选
  默认 20

  Max number of links to follow per level of the tree (i.e., per page).

• select_pathsarray可选
  默认 null

  Regex patterns to select only URLs with specific path patterns (e.g., `/docs/.*`, `/api/v1.*`).

• select_domainsarray可选
  默认 null

  Regex patterns to select crawling to specific domains or subdomains (e.g., `^docs\.example\.com$`).

• exclude_pathsarray可选
  默认 null

  Regex patterns to exclude URLs with specific path patterns (e.g., `/private/.*`, `/admin/.*`).

• exclude_domainsarray可选
  默认 null

  Regex patterns to exclude specific domains or subdomains from crawling (e.g., `^private\.example\.com$`).

• allow_externalboolean可选
  默认 true

  Whether to include external domain links in the final results list.

• ▸ 更多参数（2）

  • timeoutnumber可选
    默认 150

    Maximum time in seconds to wait for the map operation before timing out. Must be between 10 and 150 seconds.

  • include_usageboolean可选
    默认 false

    Whether to include credit usage information in the response.`NOTE:`The value may be 0 if the total successful pages mapped has not yet reached 10 calls. See our [Credits & Pricing documentation](https://docs.tavily.com/documentation/api-credits) for details.

Returns

200

Your account balance must be above 0 before the call. Billed by the credits the call actually consumed, $0.01 per credit; when the upstream reports no usage, the call is billed at the most it could have consumed.

Errors follow the Tavily format — see error codes