For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign Up
DocumentationAPI ReferenceSDKs
DocumentationAPI ReferenceSDKs
  • Documents
    • Ingest Documents
    • Ingest Directories
    • POSTcrawl_website
    • GETget_processing_status_by_id
    • GETlist
    • GETget
    • GETlookup
    • DELdelete (singular)
    • DELdelete (multiple)
    • GETget_processes
    • POSTcopy
    • PUTupdate
    • DELcancel_process
    • GETget_extract
    • GETget_xray
  • Search
    • POSTsearch.content
    • POSTsearch.documents
  • Buckets
    • GETlist
    • GETget
    • POSTcreate
    • PUTupdate
    • DELdelete
  • Groups
    • GETlist
    • GETget
    • POSTcreate
    • PUTupdate
    • DELdelete
    • POSTaddBucket
    • DELremoveBucket
  • Workflows
    • GETlist
    • POSTcreate
    • GETget_account
    • POSTadd_to_account
    • DELremove_from_account
    • POSTadd_to_id
    • DELremove_from_id
    • GETget
    • PUTupdate
    • DELdelete
  • Customer
    • GETget
  • API Key
    • GETlist
    • POSTcreate
    • PUTupdate
    • DELdelete
  • Health
    • GETlist
    • GETget
Sign Up
LogoLogo
Documents

copy

POST
https://api.groundx.ai/api/v1/ingest/copy
POST
/api/v1/ingest/copy
1from groundx import GroundX
2
3client = GroundX(
4    api_key="YOUR_API_KEY_HERE",
5)
6
7client.documents.copy(
8    to_bucket=5678,
9)
200Successful
1{
2  "ingest": {
3    "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4    "status": "queued",
5    "id": 101,
6    "progress": {
7      "cancelled": {
8        "documents": [
9          {
10            "documentId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
11            "bucketId": 1234,
12            "fileName": "project_plan.bmp",
13            "fileSize": "2.3MB",
14            "fileType": "bmp",
15            "filter": {
16              "key": "confidential",
17              "another_key": {
18                "nested": "true"
19              }
20            },
21            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
22            "processLevel": "none",
23            "searchData": {},
24            "sourceUrl": "https://documents.example.com/project_plan.bmp",
25            "status": "cancelled",
26            "statusMessage": "User cancelled the copy operation",
27            "textUrl": "https://text.example.com/project_plan.txt",
28            "xrayUrl": "https://xray.example.com/project_plan.json"
29          }
30        ],
31        "total": 1
32      },
33      "complete": {
34        "documents": [
35          {
36            "documentId": "a123f1ee-7c54-4b01-90e6-d701748f0999",
37            "bucketId": 5678,
38            "fileName": "budget_report.bmp",
39            "fileSize": "1.8MB",
40            "fileType": "bmp",
41            "filter": {
42              "key": "finance",
43              "another_key": {
44                "nested": "approved"
45              }
46            },
47            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
48            "processLevel": "none",
49            "searchData": {},
50            "sourceUrl": "https://documents.example.com/budget_report.bmp",
51            "status": "complete",
52            "statusMessage": "Document copied successfully",
53            "textUrl": "https://text.example.com/budget_report.txt",
54            "xrayUrl": "https://xray.example.com/budget_report.json"
55          }
56        ],
57        "total": 1
58      },
59      "errors": {
60        "documents": [
61          {
62            "documentId": "b456f1ee-8c54-4b01-90e6-d701748f0888",
63            "bucketId": 1234,
64            "fileName": "contract.bmp",
65            "fileSize": "3.1MB",
66            "fileType": "bmp",
67            "filter": {
68              "key": "legal",
69              "another_key": {
70                "nested": "pending"
71              }
72            },
73            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
74            "processLevel": "none",
75            "searchData": {},
76            "sourceUrl": "https://documents.example.com/contract.bmp",
77            "status": "error",
78            "statusMessage": "Failed to copy due to permission error",
79            "textUrl": "https://text.example.com/contract.txt",
80            "xrayUrl": "https://xray.example.com/contract.json"
81          }
82        ],
83        "total": 1
84      },
85      "processing": {
86        "documents": [
87          {
88            "documentId": "c789f1ee-9c54-4b01-90e6-d701748f0777",
89            "bucketId": 1234,
90            "fileName": "presentation.bmp",
91            "fileSize": "4.0MB",
92            "fileType": "bmp",
93            "filter": {
94              "key": "marketing",
95              "another_key": {
96                "nested": "draft"
97              }
98            },
99            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
100            "processLevel": "none",
101            "searchData": {},
102            "sourceUrl": "https://documents.example.com/presentation.bmp",
103            "status": "processing",
104            "statusMessage": "Copy in progress",
105            "textUrl": "https://text.example.com/presentation.txt",
106            "xrayUrl": "https://xray.example.com/presentation.json"
107          }
108        ],
109        "total": 1
110      },
111      "queued": {
112        "documents": [
113          {
114            "documentId": "d012f1ee-0c54-4b01-90e6-d701748f0666",
115            "bucketId": 1234,
116            "fileName": "notes.bmp",
117            "fileSize": "0.9MB",
118            "fileType": "bmp",
119            "filter": {
120              "key": "personal",
121              "another_key": {
122                "nested": "archived"
123              }
124            },
125            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
126            "processLevel": "none",
127            "searchData": {},
128            "sourceUrl": "https://documents.example.com/notes.bmp",
129            "status": "queued",
130            "statusMessage": "Waiting to start copy",
131            "textUrl": "https://text.example.com/notes.txt",
132            "xrayUrl": "https://xray.example.com/notes.json"
133          }
134        ],
135        "total": 1
136      }
137    },
138    "statusMessage": "Copy operation queued successfully"
139  }
140}
copy documents from one bucket to another
Was this page helpful?
Previous

update

Next
Built with

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