Tavily Crawl API

Tavily crawl.

GET/v1/tavily/crawl

1 credit per successful callCache window 15 minutesFull API reference ↗

Coverage is rolling out during preview. Test the endpoint you need before integrating. Unavailable operations return an explicit error and use no credits.

Try this endpoint

Enter the documented inputs, run a protected browser test, and inspect the JSON response.

GET/v1/tavily/crawl

urlrequiredThe public URL of the resource you want to look up.

Optional parameters (12)

max_depthoptionalProvide max depth in the format shown in the example.max_breadthoptionalProvide max breadth in the format shown in the example.limitoptionalThe requested result limit. Check the API reference for allowed values.instructionsoptionalProvide instructions in the format shown in the example.select_pathsoptionalProvide select paths in the format shown in the example.select_domainsoptionalProvide select domains in the format shown in the example.exclude_pathsoptionalProvide exclude paths in the format shown in the example.exclude_domainsoptionalProvide exclude domains in the format shown in the example.allow_externaloptionalProvide allow external in the format shown in the example.extract_depthoptionalProvide extract depth in the format shown in the example.formatoptionalProvide format in the format shown in the example.categoriesoptionalProvide categories in the format shown in the example.

No API key needed for this protected browser test. Production calls require a server-side SocialQuery key.

Request preview

Copy this request into your server-side integration, or run a test to inspect the response.

curl -X GET 'https://socialquery.dev/v1/tavily/crawl?url=https%3A%2F%2Fdocs.tavily.com' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"

Request contract

Parameters

Pass these fields as query parameters. Production requests also require your server-side API key.

urlRequired: The public URL of the resource you want to look up.
Example: https://docs.tavily.com
max_depthOptional: Provide max depth in the format shown in the example.
Example: 10
max_breadthOptional: Provide max breadth in the format shown in the example.
Example: 10
limitOptional: The requested result limit. Check the API reference for allowed values.
Example: 10
instructionsOptional: Provide instructions in the format shown in the example.
Example: —
select_pathsOptional: Provide select paths in the format shown in the example.
Example: —
select_domainsOptional: Provide select domains in the format shown in the example.
Example: —
exclude_pathsOptional: Provide exclude paths in the format shown in the example.
Example: —
exclude_domainsOptional: Provide exclude domains in the format shown in the example.
Example: —
allow_externalOptional: Provide allow external in the format shown in the example.
Example: false
extract_depthOptional: Provide extract depth in the format shown in the example.
Example: basic
formatOptional: Provide format in the format shown in the example.
Example: markdown
categoriesOptional: Provide categories in the format shown in the example.
Example: —

Build a reliable integration.

Keep your key server-side

Pass your SocialQuery key in the x-api-key header. Never expose credentials in a browser bundle.

Check the response

Read success before using data. Preserve request_id when logging errors or contacting support.

Account for coverage

Test the fields you need. Provider availability varies, and unavailable operations use no credits.

More Tavily endpoints

View all →