HYhyperspell
Integrations

Crawl a website for indexed search

Changed on

Recursively crawl a website to make it available for indexed search.

get/integrations/web_crawler/index

Request

  • Base URL
    https://api.hyperspell.com
  • URL
    https://api.hyperspell.com/integrations/web_crawler/index
  • Auth
    HTTP bearer

Query parameters

urlstring required

The base URL of the website to crawl

max_depthinteger

Maximum depth of links to follow during crawling

limitinteger

Maximum number of pages to crawl in total

Headers

X-As-Userstring nullable

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Response

Successful Response

source'reddit' | 'notion' | 'slack' | 'google_calendar' | 'google_mail' | 'imap' | 'google_meet' | 'box' | 'dropbox' | 'github' | 'gitlab' | 'google_drive' | 'vault' | 'web_crawler' | 'trace' | 'microsoft_outlook' | 'microsoft_teams' | 'granola' | 'fathom' | 'fireflies' | 'figma' | 'linear' | 'hubspot' | 'salesforce' | 'coda' | 'confluence' | 'jira' | 'metabase' | 'gong' | 'clickup' | 'lightfield' | 'pylon' | 'fellow' | 'odoo' | 'external_mcp' | 'page' required
resource_idstring required
status'pending' | 'processing' | 'completed' | 'failed' | 'pending_review' | 'skipped' | 'filtered' | 'cancelled' required

Changes

  • cdf64d80b832Revision changes
    • breaking

      for the query request parameter url, the minLength was increased from 0 to 1

    • warning

      for the query request parameter url, the maxLength was set to 2048

  • 77d3e8d5e8a7Revision changes
    • warning

      added the new gong enum value to the response property for the response status