copy

POST

https://api.groundx.ai/api/v1/ingest/copy

POST

/api/v1/ingest/copy

1 from groundx import GroundX
2 
3 client = GroundX(
4     api_key="YOUR_API_KEY",
5 )
6 client.documents.copy(
7     to_bucket=1234,
8 )

Try it

200Successful

1 {
2   "ingest": {
3     "processId": "string",
4     "status": "queued",
5     "id": 1,
6     "progress": {
7       "cancelled": {
8         "documents": [
9           {
10             "documentId": "string",
11             "bucketId": 1,
12             "fileName": "string",
13             "fileSize": "1.4MB",
14             "fileType": "bmp",
15             "filter": {
16               "key": "value",
17               "another_key": {
18                 "nested": "value"
19               }
20             },
21             "processId": "string",
22             "processLevel": "none",
23             "searchData": {},
24             "sourceUrl": "string",
25             "status": "queued",
26             "statusMessage": "string",
27             "textUrl": "string",
28             "xrayUrl": "string"
29           }
30         ],
31         "total": 1
32       },
33       "complete": {
34         "documents": [
35           {
36             "documentId": "string",
37             "bucketId": 1,
38             "fileName": "string",
39             "fileSize": "1.4MB",
40             "fileType": "bmp",
41             "filter": {
42               "key": "value",
43               "another_key": {
44                 "nested": "value"
45               }
46             },
47             "processId": "string",
48             "processLevel": "none",
49             "searchData": {},
50             "sourceUrl": "string",
51             "status": "queued",
52             "statusMessage": "string",
53             "textUrl": "string",
54             "xrayUrl": "string"
55           }
56         ],
57         "total": 1
58       },
59       "errors": {
60         "documents": [
61           {
62             "documentId": "string",
63             "bucketId": 1,
64             "fileName": "string",
65             "fileSize": "1.4MB",
66             "fileType": "bmp",
67             "filter": {
68               "key": "value",
69               "another_key": {
70                 "nested": "value"
71               }
72             },
73             "processId": "string",
74             "processLevel": "none",
75             "searchData": {},
76             "sourceUrl": "string",
77             "status": "queued",
78             "statusMessage": "string",
79             "textUrl": "string",
80             "xrayUrl": "string"
81           }
82         ],
83         "total": 1
84       },
85       "processing": {
86         "documents": [
87           {
88             "documentId": "string",
89             "bucketId": 1,
90             "fileName": "string",
91             "fileSize": "1.4MB",
92             "fileType": "bmp",
93             "filter": {
94               "key": "value",
95               "another_key": {
96                 "nested": "value"
97               }
98             },
99             "processId": "string",
100             "processLevel": "none",
101             "searchData": {},
102             "sourceUrl": "string",
103             "status": "queued",
104             "statusMessage": "string",
105             "textUrl": "string",
106             "xrayUrl": "string"
107           }
108         ],
109         "total": 1
110       }
111     },
112     "statusMessage": "string"
113   }
114 }

copy documents from one bucket to another

Authentication

X-API-Keystring

API Key authentication via header

Request

This endpoint expects an object.

toBucketintegerRequired

The bucketId of the bucket the file will be copied into.

documentIdslist of stringsOptional

The document IDs of the files you wish to copy.

fromBucketintegerOptional

The bucketId of the bucket you wish to copy ALL files from.

Response

Copy request successfully submitted

ingestobject