Documents

get_processing_status_by_id

Changed on Jul 25, 2024

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}

Request

Base URL
https://api.groundx.ai/api
URL
https://api.groundx.ai/api/v1/ingest/{processId}
Auth
API key in header X-API-Key

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

Jul 25, 2024100a68ae1698 Revision changes
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the required property ///// to the response with the status
- info
  added the required property ///// to the response with the status
- info
  added the required property ///// to the response with the status
- info
  added the required property ///// to the response with the status
Jul 25, 2024af54b546cf62 Revision changes
- info
  the response property ////// became required for the status
- info
  the response property ////// became required for the status
- info
  the response property ////// became required for the status
- info
  the response property ////// became required for the status

Operation history (12 revisions)