Documents

get_processing_status_by_id

Get the current status of an ingest, initiated with documents.ingest_remote, documents.ingest_local, or documents.crawl_website, by specifying the processId (the processId is included in the response of the documents.ingest functions).

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.

get/v1/ingest/{processId}

Path parameters

processIdstring uuid required

the processId for the ingest process being checked

Response

Look up success

Example response

{
  "ingest": {
    "progress": {
      "cancelled": {
        "documents": [
          {
            "fileSize": "1.4MB"
          }
        ]
      },
      "complete": {
        "documents": [
          {
            "fileSize": "1.4MB"
          }
        ]
      },
      "errors": {
        "documents": [
          {
            "fileSize": "1.4MB"
          }
        ]
      },
      "processing": {
        "documents": [
          {
            "fileSize": "1.4MB"
          }
        ]
      }
    }
  }
}

Changes

Changed in 11 of the 50 revisions of this API.89578

Jul 25, 2024100a68ae1698444See the full diff
- ●
  removed the optional property ///// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ///// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ///// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ///// from the response with the status
  response-optional-property-removed
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
Jul 25, 2024af54b546cf624See 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
- ○
  the response property ////// became required for the status
  response-property-became-required
Jun 28, 2024f97e210f14314See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
Feb 1, 2024bc7318def1074See the full diff
- ●
  added the new json enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new json enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new json enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new json enum value to the ////// response property for the response status
  response-property-enum-value-added
Dec 31, 20234c5920188a7d8See the full diff
- ●
  added the new csv enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new csv enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new csv enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new csv enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new tsv enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new tsv enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new tsv enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new tsv enum value to the ////// response property for the response status
  response-property-enum-value-added
Nov 29, 20233bb56505863644See the full diff
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 29, 2023bf7061385e181402See the full diff
- ▲
  for the path request parameter processId, the format changed from no format to uuid
  request-parameter-type-changed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  added the new cancelled enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new cancelled enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new cancelled enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new cancelled enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new complete enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new complete enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new complete enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new docx enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new docx enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new docx 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 error 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 jpg enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new jpg enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new jpg enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new pdf enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new pdf enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new pdf enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new png enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new png enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new png enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new pptx enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new pptx enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new pptx 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 processing 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
- ●
  added the new queued 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
- ●
  added the new txt enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new txt enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new txt enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new xlsx enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new xlsx enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new xlsx enum value to the ////// response property for the response status
  response-property-enum-value-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 5, 20235ee59ea914aa2See the full diff
- ○
  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, 20239f04a009540844See 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
- ○
  api operation id Document_getProcessingStatusByProcessId removed and replaced with Document_getProcessingStatusById
  api-operation-id-removed
- ○
  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
Oct 4, 20237d474e21a1082See the full diff
- ○
  api operation id Document_getProcessingStatusByProcessId was added
  api-operation-id-added
- ○
  api tag Document added
  api-tag-added

Full history (11 revisions)