---
title: "get_processing_status_by_id"
method: GET
path: "/v1/ingest/{processId}"
tags: ["Documents"]
---

# get_processing_status_by_id

`GET /v1/ingest/{processId}`

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.

## Path parameters

- `processId` string, uuid, required

## Response `200`

Look up success

- ProcessStatusResponse
  - `ingest` object, required
    - `processId` string, uuid, required
    - `progress` object
      - `cancelled` object
        - `documents` DocumentDetail[]
          - `bucketId` integer
          - `documentId` string, uuid, required — Unique system generated ID for the document
          - `fileName` string
          - `fileSize` string — The file size of the file stored in GroundX
          - `fileType` 'txt' | 'docx' | 'pptx' | 'xlsx' | 'pdf' | 'png' | 'jpg' | 'csv' | 'tsv' | 'json' — The type of document (one of the seven currently supported file types)
          - `processId` string, uuid — Unique system generated ID for the ingest request
          - `searchData` object
          - `sourceUrl` string, uri — Source document URL
          - `status` 'queued' | 'processing' | 'error' | 'complete' | 'cancelled'
          - `statusMessage` string
          - `xrayUrl` string, uri — Document X-Ray results
        - `total` integer
      - `complete` object
        - `documents` DocumentDetail[]
          - `bucketId` integer
          - `documentId` string, uuid, required — Unique system generated ID for the document
          - `fileName` string
          - `fileSize` string — The file size of the file stored in GroundX
          - `fileType` 'txt' | 'docx' | 'pptx' | 'xlsx' | 'pdf' | 'png' | 'jpg' | 'csv' | 'tsv' | 'json' — The type of document (one of the seven currently supported file types)
          - `processId` string, uuid — Unique system generated ID for the ingest request
          - `searchData` object
          - `sourceUrl` string, uri — Source document URL
          - `status` 'queued' | 'processing' | 'error' | 'complete' | 'cancelled'
          - `statusMessage` string
          - `xrayUrl` string, uri — Document X-Ray results
        - `total` integer
      - `errors` object
        - `documents` DocumentDetail[]
          - `bucketId` integer
          - `documentId` string, uuid, required — Unique system generated ID for the document
          - `fileName` string
          - `fileSize` string — The file size of the file stored in GroundX
          - `fileType` 'txt' | 'docx' | 'pptx' | 'xlsx' | 'pdf' | 'png' | 'jpg' | 'csv' | 'tsv' | 'json' — The type of document (one of the seven currently supported file types)
          - `processId` string, uuid — Unique system generated ID for the ingest request
          - `searchData` object
          - `sourceUrl` string, uri — Source document URL
          - `status` 'queued' | 'processing' | 'error' | 'complete' | 'cancelled'
          - `statusMessage` string
          - `xrayUrl` string, uri — Document X-Ray results
        - `total` integer
      - `processing` object
        - `documents` DocumentDetail[]
          - `bucketId` integer
          - `documentId` string, uuid, required — Unique system generated ID for the document
          - `fileName` string
          - `fileSize` string — The file size of the file stored in GroundX
          - `fileType` 'txt' | 'docx' | 'pptx' | 'xlsx' | 'pdf' | 'png' | 'jpg' | 'csv' | 'tsv' | 'json' — The type of document (one of the seven currently supported file types)
          - `processId` string, uuid — Unique system generated ID for the ingest request
          - `searchData` object
          - `sourceUrl` string, uri — Source document URL
          - `status` 'queued' | 'processing' | 'error' | 'complete' | 'cancelled'
          - `statusMessage` string
          - `xrayUrl` string, uri — Document X-Ray results
        - `total` integer
    - `status` 'queued' | 'processing' | 'error' | 'complete' | 'cancelled', required
    - `statusMessage` string

## Other responses

- `400` — Invalid process ID
- `401` — Unauthorized to access process with given ID

---

[API](https://skmtc.net/groundxai/apis/groundx-apis.md) · [All operations](https://skmtc.net/groundxai/apis/groundx-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/groundxai/groundx-apis/versions/1c1a5c17f52f/schema)