get_processing_status_by

get_processing_status_by_id

get

https://api.groundx.ai/api/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.

Execute an API Request

Path

processIdstring (format: uuid)required

the processId for the ingest process being checked

Authorization

X-API-Key

Request

Installation

GitHub npm

npm install groundx-typescript-sdk

1
Loading...

Response fields

object

ingestobject

processIdstring (format: uuid)

progressobject

cancelledobject

completeobject

errorsobject

processingobject

statusstring

statusMessagestring

1
{
2
  "ingest": {
3
    "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
4
    "progress": {
5
      "cancelled": {
6
        "documents": [
7
          {
8
            "bucketId": 0,
9
            "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
10
            "fileName": "string",
11
            "fileSize": "1.4MB",
12
            "fileType": "txt",
13
            "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
14
            "searchData": {},
15
            "sourceUrl": "http://example.com",
16
            "status": "queued",
17
            "statusMessage": "string",
18
            "xrayUrl": "http://example.com"
19
          }
20
        ],
21
        "total": 0
22
      },
23
      "complete": {
24
        "documents": [
25
          {
26
            "bucketId": 0,
27
            "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
28
            "fileName": "string",
29
            "fileSize": "1.4MB",
30
            "fileType": "txt",
31
            "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
32
            "searchData": {},
33
            "sourceUrl": "http://example.com",
34
            "status": "queued",
35
            "statusMessage": "string",
36
            "xrayUrl": "http://example.com"
37
          }
38
        ],
39
        "total": 0
40
      },
41
      "errors": {
42
        "documents": [
43
          {
44
            "bucketId": 0,
45
            "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
46
            "fileName": "string",
47
            "fileSize": "1.4MB",
48
            "fileType": "txt",
49
            "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
50
            "searchData": {},
51
            "sourceUrl": "http://example.com",
52
            "status": "queued",
53
            "statusMessage": "string",
54
            "xrayUrl": "http://example.com"
55
          }
56
        ],
57
        "total": 0
58
      },
59
      "processing": {
60
        "documents": [
61
          {
62
            "bucketId": 0,
63
            "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
64
            "fileName": "string",
65
            "fileSize": "1.4MB",
66
            "fileType": "txt",
67
            "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
68
            "searchData": {},
69
            "sourceUrl": "http://example.com",
70
            "status": "queued",
71
            "statusMessage": "string",
72
            "xrayUrl": "http://example.com"
73
          }
74
        ],
75
        "total": 0
76
      }
77
    },
78
    "status": "queued",
79
    "statusMessage": "string"
80
  }
81
}

Made with Konfig