Integrations

Index a public website

Changed on
post/integrations/web_crawler/crawl

Request

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

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

Request body

share'personal' | 'shared' nullable

Visibility for new pages. New websites default to shared; existing websites keep their saved choice.

urlstring required
max_depthinteger nullable

Link depth to follow. Defaults to the saved website's depth, or 3 for a new website.

limitinteger nullable

Maximum pages to index. Defaults to the saved website's limit, or 100 for a new website.

Response

Successful Response

urlstring
statusstring
discoveredinteger nullable
indexedinteger nullable
failedinteger nullable
limitinteger
limit_reachedboolean
errorsstring[]
duplicatesinteger
run_idstring nullable

Changes

  • 9bafd1215a0fRevision changes
    • info

      the request property default value 100 was removed

    • info

      the request property default value 3 was removed

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

  • cdf64d80b832Revision changes
    • info

      endpoint added