get_extract | Documentation

Look up extractions for an existing document by documentId.

X-API-Keystring

API Key authentication via header

documentIdstringRequiredformat: "uuid"

The documentId of the document for which GroundX extract has extracted information.

Look up success

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_extract(
8	document_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
9	)

1	{
2	"extractions": [
3	{
4	"field": "InvoiceNumber",
5	"value": "INV-20240615-001",
6	"confidence": 0.98
7	},
8	{
9	"field": "InvoiceDate",
10	"value": "2024-06-15",
11	"confidence": 0.95
12	},
13	{
14	"field": "TotalAmount",
15	"value": "1250.75",
16	"confidence": 0.97
17	}
18	],
19	"documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
20	"status": "extraction_completed",
21	"retrievedAt": "2024-06-20T10:15:30Z"
22	}

1	from groundx import GroundX
2
3	client = GroundX(
4	api_key="YOUR_API_KEY_HERE",
5	)
6
7	client.documents.get_extract(
8	document_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
9	)

1	{
2	"extractions": [
3	{
4	"field": "InvoiceNumber",
5	"value": "INV-20240615-001",
6	"confidence": 0.98
7	},
8	{
9	"field": "InvoiceDate",
10	"value": "2024-06-15",
11	"confidence": 0.95
12	},
13	{
14	"field": "TotalAmount",
15	"value": "1250.75",
16	"confidence": 0.97
17	}
18	],
19	"documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
20	"status": "extraction_completed",
21	"retrievedAt": "2024-06-20T10:15:30Z"
22	}