update | Documentation

from groundx import GroundX, DocumentUpdateRequestItem
client = GroundX(
    api_key="YOUR_API_KEY_HERE",
)
client.documents.update(
    request=[
        DocumentUpdateRequestItem(
            document_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
        )
    ],
)

{
  "ingest": {
    "processId": "7e57d004-2b97-0e7a-b45f-5387367791cd",
    "status": "queued",
    "id": 1024,
    "progress": {
      "cancelled": {
        "documents": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "bucketId": 12,
            "fileName": "project_plan_v2.pdf",
            "fileSize": "2.3MB",
            "fileType": "pdf",
            "filter": {
              "key": "finance",
              "another_key": {
                "nested": "Q1_reports"
              }
            },
            "processId": "7e57d004-2b97-0e7a-b45f-5387367791cd",
            "processLevel": "none",
            "searchData": {},
            "sourceUrl": "https://documents.example.com/project_plan_v2.pdf",
            "status": "cancelled",
            "statusMessage": "User cancelled processing",
            "textUrl": "https://textstorage.example.com/project_plan_v2.txt",
            "xrayUrl": "https://xray.example.com/project_plan_v2.json"
          }
        ],
        "total": 1
      },
      "complete": {
        "documents": [
          {
            "documentId": "9b2c1f3a-4d5e-4f6a-8b7c-123456789abc",
            "bucketId": 12,
            "fileName": "annual_report_2023.pdf",
            "fileSize": "5.1MB",
            "fileType": "pdf",
            "filter": {
              "key": "annual",
              "another_key": {
                "nested": "reports"
              }
            },
            "processId": "7e57d004-2b97-0e7a-b45f-5387367791cd",
            "processLevel": "full",
            "searchData": {},
            "sourceUrl": "https://documents.example.com/annual_report_2023.pdf",
            "status": "complete",
            "statusMessage": "Processing completed successfully",
            "textUrl": "https://textstorage.example.com/annual_report_2023.txt",
            "xrayUrl": "https://xray.example.com/annual_report_2023.json"
          }
        ],
        "total": 1
      },
      "errors": {
        "documents": [
          {
            "documentId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
            "bucketId": 12,
            "fileName": "budget_overview.xlsx",
            "fileSize": "1.8MB",
            "fileType": "xlsx",
            "filter": {
              "key": "budget",
              "another_key": {
                "nested": "Q2"
              }
            },
            "processId": "7e57d004-2b97-0e7a-b45f-5387367791cd",
            "processLevel": "full",
            "searchData": {},
            "sourceUrl": "https://documents.example.com/budget_overview.xlsx",
            "status": "error",
            "statusMessage": "File corrupted during upload",
            "textUrl": "https://textstorage.example.com/budget_overview.txt",
            "xrayUrl": "https://xray.example.com/budget_overview.json"
          }
        ],
        "total": 1
      },
      "processing": {
        "documents": [
          {
            "documentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "bucketId": 12,
            "fileName": "meeting_notes.docx",
            "fileSize": "0.9MB",
            "fileType": "docx",
            "filter": {
              "key": "meetings",
              "another_key": {
                "nested": "team_alpha"
              }
            },
            "processId": "7e57d004-2b97-0e7a-b45f-5387367791cd",
            "processLevel": "full",
            "searchData": {},
            "sourceUrl": "https://documents.example.com/meeting_notes.docx",
            "status": "processing",
            "statusMessage": "Currently processing document",
            "textUrl": "https://textstorage.example.com/meeting_notes.txt",
            "xrayUrl": "https://xray.example.com/meeting_notes.json"
          }
        ],
        "total": 1
      },
      "queued": {
        "documents": [
          {
            "documentId": "f0e1d2c3-b4a5-6789-0abc-def123456789",
            "bucketId": 12,
            "fileName": "strategy_outline.pptx",
            "fileSize": "3.2MB",
            "fileType": "pptx",
            "filter": {
              "key": "strategy",
              "another_key": {
                "nested": "Q3_plans"
              }
            },
            "processId": "7e57d004-2b97-0e7a-b45f-5387367791cd",
            "processLevel": "none",
            "searchData": {},
            "sourceUrl": "https://documents.example.com/strategy_outline.pptx",
            "status": "queued",
            "statusMessage": "Waiting in queue for processing",
            "textUrl": "https://textstorage.example.com/strategy_outline.txt",
            "xrayUrl": "https://xray.example.com/strategy_outline.json"
          }
        ],
        "total": 1
      }
    },
    "statusMessage": "Documents are queued for processing"
  }
}

Update some attributes of documents that have been uploaded to GroundX.

Authentication

X-API-Keystring

API Key authentication via header

Request

This endpoint expects a list of objects.

documentIdstringRequiredformat: "uuid"

The document ID of the file you wish to update.

fileNamestringOptional

The name you wish to change for the file.

filterobjectOptional

A dictionary of key-value pairs that will replace the existing filter.

searchDataobjectOptional

A dictionary of key-value pairs that will replace the existing searchData.

Response

Documents successfully submitted for updates

ingestobject

Errors

400

Bad Request Error

401

Unauthorized Error