v1

latestOpenAPI 3.0.0Apache 2.02026-07-17263751.6 KB

Documents

crawl_website

Upload the content of a publicly accessible website for ingestion into a GroundX bucket. This is done by following links within a specified URL, recursively, up to a specified depth or number of pages.

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

post/v1/ingest/documents/website

Request body

Example request

{
  "websites": [
    {
      "bucketId": 123,
      "cap": 100,
      "depth": 3,
      "searchData": {
        "key": "value"
      },
      "sourceUrl": "https://my.website.com"
    }
  ]
}

Response

Website successfully queued