Documents

ingest_remote

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

Changed in 16 of the 50 revisions of this API.81623

Jul 16, 2024fc97f6aaa7471See the full diff
- ○
  api operation id Document_uploadRemote removed and replaced with Document_ingestRemote
  api-operation-id-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 1, 2024bc7318def1071See the full diff
- ○
  added the new json enum value to the request property //
  request-property-enum-value-added
Dec 31, 20234c5920188a7d2See the full diff
- ○
  added the new csv enum value to the request property //
  request-property-enum-value-added
- ○
  added the new tsv enum value to the request property //
  request-property-enum-value-added
Nov 29, 20233bb56505863631See the full diff
- ●
  removed the request property //
  request-property-removed
- ●
  removed the request property //
  request-property-removed
- ●
  removed the request property //
  request-property-removed
- ○
  added the new optional request property //
  new-optional-request-property
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 29, 2023bf7061385e18222See the full diff
- ▲
  the // request property format changed from no format to uri
  request-property-type-changed
- ▲
  the // request property format changed from no format to uri
  request-property-type-changed
- ●
  removed the request property //
  request-property-removed
- ●
  added the new cancelled enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the new optional request property //
  new-optional-request-property
- ○
  added the new optional request property //
  new-optional-request-property
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 7, 202350642c47d87311See the full diff
- ▲
  the request property became required
  request-property-became-required
- ●
  removed the request property
  request-property-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 5, 20235ee59ea914aa52See the full diff
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ○
  api tag Documents added
  api-tag-added
- ○
  api tag Document removed
  api-tag-removed
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 5, 202305194fdd107e4See the full diff
- ●
  added the new complete enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new error enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new processing enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new queued enum value to the / response property for the response status
  response-property-enum-value-added
Oct 5, 2023006f5c1a8d401See the full diff
- ○
  the request property became optional
  request-property-became-optional
Oct 5, 20239f04a00954083See the full diff
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property / became required for the status
  response-property-became-required
- ○
  the response property / became required for the status
  response-property-became-required

Full history (16 revisions)