get | Documentation

from groundx import GroundX
client = GroundX(
    api_key="YOUR_API_KEY_HERE",
)
client.documents.get(
    document_id="documentId",
)

{
  "document": {
    "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bucketId": 42,
    "fileName": "Quarterly_Report_Q1_2024.pdf",
    "fileSize": "2.3MB",
    "fileType": "pdf",
    "filter": {
      "department": "finance",
      "review_status": {
        "approved": "true"
      }
    },
    "processId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "processLevel": "full",
    "searchData": {},
    "sourceUrl": "https://companydocs.example.com/reports/Q1_2024.pdf",
    "status": "complete",
    "statusMessage": "Document processed successfully",
    "textUrl": "https://storage.groundx.ai/texts/3fa85f64-5717-4562-b3fc-2c963f66afa6.txt",
    "xrayUrl": "https://storage.groundx.ai/xray/3fa85f64-5717-4562-b3fc-2c963f66afa6.json"
  }
}

Look up an existing document by documentId.

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

documentIdstringRequiredformat: "uuid"

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

Response

Look up success

documentobject

Errors

400

Bad Request Error

401

Unauthorized Error

1	from groundx import GroundX
2
3	client = GroundX(
4	api_key="YOUR_API_KEY_HERE",
5	)
6
7	client.documents.get(
8	document_id="documentId",
9	)

1	{
2	"document": {
3	"documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4	"bucketId": 42,
5	"fileName": "Quarterly_Report_Q1_2024.pdf",
6	"fileSize": "2.3MB",
7	"fileType": "pdf",
8	"filter": {
9	"department": "finance",
10	"review_status": {
11	"approved": "true"
12	}
13	},
14	"processId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
15	"processLevel": "full",
16	"searchData": {},
17	"sourceUrl": "https://companydocs.example.com/reports/Q1_2024.pdf",
18	"status": "complete",
19	"statusMessage": "Document processed successfully",
20	"textUrl": "https://storage.groundx.ai/texts/3fa85f64-5717-4562-b3fc-2c963f66afa6.txt",
21	"xrayUrl": "https://storage.groundx.ai/xray/3fa85f64-5717-4562-b3fc-2c963f66afa6.json"
22	}
23	}