logo
Documents

get

get
https://api.groundx.ai/api/v1/ingest/document/{documentId}

Look up an existing document by documentId.

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
documentIdstring (format: uuid)required

The documentId of the document for which GroundX information will be provided.

Authorization
Request
Installation
$
npm install groundx-typescript-sdk
1
Loading...

Response fields

object
documentobject
1
{
2
"document": {
3
"bucketId": 0,
4
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
5
"fileName": "string",
6
"fileSize": "1.4MB",
7
"fileType": "txt",
8
"processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
9
"searchData": {},
10
"sourceUrl": "http://example.com",
11
"status": "queued",
12
"statusMessage": "string",
13
"xrayUrl": "http://example.com"
14
}
15
}