get_processes | Documentation

Get a list of ingest process requests, sorted from most recent to least.

X-API-Keystring

API Key authentication via header

nintegerOptional

The maximum number of returned processes. Accepts 1-100 with a default of 20.

statusenumOptional

A status filter on the processing status. If this value is set, then only processes with this status will be returned in the results.

Look up success

processeslist of objects

Processes

API Key authentication via header

The maximum number of returned processes. Accepts 1-100 with a default of 20.

A status filter on the processing status. If this value is set, then only processes with this status will be returned in the results.

1	from groundx import GroundX
2
3	client = GroundX(
4	api_key="YOUR_API_KEY_HERE",
5	)
6
7	client.documents.get_processes()

1	{
2	"processes": [
3	{
4	"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5	"status": "processing",
6	"id": 1024,
7	"statusMessage": "Ingest process started and currently running"
8	},
9	{
10	"processId": "1c6b147a-8f3d-4a2a-9f3e-9b7a1d2e4f5b",
11	"status": "complete",
12	"id": 1023,
13	"statusMessage": "Ingest process completed successfully"
14	},
15	{
16	"processId": "7d9f3e2a-4b1c-4f7a-8e2d-3a9b7c1d5e6f",
17	"status": "error",
18	"id": 1022,
19	"statusMessage": "Failed due to file format not supported"
20	}
21	]
22	}

1	from groundx import GroundX
2
3	client = GroundX(
4	api_key="YOUR_API_KEY_HERE",
5	)
6
7	client.documents.get_processes()

1	{
2	"processes": [
3	{
4	"processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5	"status": "processing",
6	"id": 1024,
7	"statusMessage": "Ingest process started and currently running"
8	},
9	{
10	"processId": "1c6b147a-8f3d-4a2a-9f3e-9b7a1d2e4f5b",
11	"status": "complete",
12	"id": 1023,
13	"statusMessage": "Ingest process completed successfully"
14	},
15	{
16	"processId": "7d9f3e2a-4b1c-4f7a-8e2d-3a9b7c1d5e6f",
17	"status": "error",
18	"id": 1022,
19	"statusMessage": "Failed due to file format not supported"
20	}
21	]
22	}