Documents

Ingest documents hosted on public URLs to a GroundX bucket.

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/remote

Request

  • Base URL
    https://api.groundx.ai/api
  • URL
    https://api.groundx.ai/api/v1/ingest/documents/remote
  • Auth
    API key in header X-API-Key

Request body

Example request

{
  "documents": [
    {
      "bucketId": 1234,
      "fileName": "my_file.txt",
      "searchData": {
        "key": "value"
      },
      "sourceUrl": "https://my.source.url.com/file.txt"
    }
  ]
}

Response

Documents successfully uploaded

Changes