Response fields
object
ingest
object
processId
string (format: uuid)
progress
object
cancelled
object
documents
array of objects
bucketId
integer
documentId
string (format: uuid)
Unique system generated ID for the document
fileName
string
fileSize
string
The file size of the file stored in GroundX
fileType
string
The type of document (one of the seven currently supported file types)
processId
string (format: uuid)
Unique system generated ID for the ingest request
searchData
object
sourceUrl
string (format: uri)
Source document URL
status
string
statusMessage
string
xrayUrl
string (format: uri)
Document X-Ray results
total
integer
complete
object
documents
array of objects
bucketId
integer
documentId
string (format: uuid)
Unique system generated ID for the document
fileName
string
fileSize
string
The file size of the file stored in GroundX
fileType
string
The type of document (one of the seven currently supported file types)
processId
string (format: uuid)
Unique system generated ID for the ingest request
searchData
object
sourceUrl
string (format: uri)
Source document URL
status
string
statusMessage
string
xrayUrl
string (format: uri)
Document X-Ray results
total
integer
errors
object
documents
array of objects
bucketId
integer
documentId
string (format: uuid)
Unique system generated ID for the document
fileName
string
fileSize
string
The file size of the file stored in GroundX
fileType
string
The type of document (one of the seven currently supported file types)
processId
string (format: uuid)
Unique system generated ID for the ingest request
searchData
object
sourceUrl
string (format: uri)
Source document URL
status
string
statusMessage
string
xrayUrl
string (format: uri)
Document X-Ray results
total
integer
processing
object
documents
array of objects
bucketId
integer
documentId
string (format: uuid)
Unique system generated ID for the document
fileName
string
fileSize
string
The file size of the file stored in GroundX
fileType
string
The type of document (one of the seven currently supported file types)
processId
string (format: uuid)
Unique system generated ID for the ingest request
searchData
object
sourceUrl
string (format: uri)
Source document URL
status
string
statusMessage
string
xrayUrl
string (format: uri)
Document X-Ray results
total
integer
status
string
statusMessage
string
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": 022},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": 040},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": 058},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": 076}77},78"status": "queued",79"statusMessage": "string"80}81}