get_xray | Documentation

Look up X-Ray data for an existing document by documentId.

X-API-Keystring

API Key authentication via header

documentIdstringRequiredformat: "uuid"

The documentId of the document for which GroundX created an X-Ray.

Look up success

400

Bad Request Error

401

Unauthorized Error

1	{
2	"documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"xrayData": {
4	"summary": "This document contains a detailed analysis of quarterly sales performance.",
5	"keywords": [
6	"sales",
7	"quarterly report",
8	"performance",
9	"analysis"
10	],
11	"entities": [
12	{
13	"type": "Organization",
14	"name": "Acme Corporation"
15	},
16	{
17	"type": "Date",
18	"value": "2024-04-01"
19	}
20	],
21	"sentiment": "positive",
22	"pageCount": 12,
23	"language": "en"
24	}
25	}

1	{
2	"documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"xrayData": {
4	"summary": "This document contains a detailed analysis of quarterly sales performance.",
5	"keywords": [
6	"sales",
7	"quarterly report",
8	"performance",
9	"analysis"
10	],
11	"entities": [
12	{
13	"type": "Organization",
14	"name": "Acme Corporation"
15	},
16	{
17	"type": "Date",
18	"value": "2024-04-01"
19	}
20	],
21	"sentiment": "positive",
22	"pageCount": 12,
23	"language": "en"
24	}
25	}