update | Documentation

from groundx import GroundX, DocumentUpdate
client = GroundX(
    api_key="YOUR_API_KEY_HERE",
)
client.documents.update(
    documents=[
        DocumentUpdate(
            document_id="string",
        )
    ],
)

{
  "ingest": {
    "processId": "string",
    "status": "queued",
    "id": 1,
    "progress": {
      "cancelled": {
        "documents": [
          {
            "documentId": "string",
            "fileAccess": {
              "mode": "public",
              "urlTtlSeconds": 1
            },
            "effectiveFileAccess": {
              "mode": "public",
              "urlTtlSeconds": 1
            },
            "bucketId": 1,
            "created": "2024-01-15T09:30:00Z",
            "deliveryStatus": "not_configured",
            "extractionProvenance": {
              "artifactRevision": "string",
              "runtimeBuildIds": [
                "string"
              ],
              "schemaHash": "string",
              "workflowId": "string",
              "workflowVersion": "string"
            },
            "extractionReady": true,
            "retryAvailable": true,
            "fileName": "string",
            "fileSize": "1.4MB",
            "fileType": "bmp",
            "filter": {
              "key": "value",
              "another_key": {
                "nested": "value"
              }
            },
            "processId": "string",
            "processLevel": "none",
            "searchData": {},
            "sourceUrl": "string",
            "hostedSourceUrl": "string",
            "status": "queued",
            "statusMessage": "string",
            "textUrl": "string",
            "xrayUrl": "string",
            "fileAccessRevision": 1
          }
        ],
        "total": 1
      },
      "complete": {
        "documents": [
          {
            "documentId": "string",
            "fileAccess": {
              "mode": "public",
              "urlTtlSeconds": 1
            },
            "effectiveFileAccess": {
              "mode": "public",
              "urlTtlSeconds": 1
            },
            "bucketId": 1,
            "created": "2024-01-15T09:30:00Z",
            "deliveryStatus": "not_configured",
            "extractionProvenance": {
              "artifactRevision": "string",
              "runtimeBuildIds": [
                "string"
              ],
              "schemaHash": "string",
              "workflowId": "string",
              "workflowVersion": "string"
            },
            "extractionReady": true,
            "retryAvailable": true,
            "fileName": "string",
            "fileSize": "1.4MB",
            "fileType": "bmp",
            "filter": {
              "key": "value",
              "another_key": {
                "nested": "value"
              }
            },
            "processId": "string",
            "processLevel": "none",
            "searchData": {},
            "sourceUrl": "string",
            "hostedSourceUrl": "string",
            "status": "queued",
            "statusMessage": "string",
            "textUrl": "string",
            "xrayUrl": "string",
            "fileAccessRevision": 1
          }
        ],
        "total": 1
      },
      "errors": {
        "documents": [
          {
            "documentId": "string",
            "fileAccess": {
              "mode": "public",
              "urlTtlSeconds": 1
            },
            "effectiveFileAccess": {
              "mode": "public",
              "urlTtlSeconds": 1
            },
            "bucketId": 1,
            "created": "2024-01-15T09:30:00Z",
            "deliveryStatus": "not_configured",
            "extractionProvenance": {
              "artifactRevision": "string",
              "runtimeBuildIds": [
                "string"
              ],
              "schemaHash": "string",
              "workflowId": "string",
              "workflowVersion": "string"
            },
            "extractionReady": true,
            "retryAvailable": true,
            "fileName": "string",
            "fileSize": "1.4MB",
            "fileType": "bmp",
            "filter": {
              "key": "value",
              "another_key": {
                "nested": "value"
              }
            },
            "processId": "string",
            "processLevel": "none",
            "searchData": {},
            "sourceUrl": "string",
            "hostedSourceUrl": "string",
            "status": "queued",
            "statusMessage": "string",
            "textUrl": "string",
            "xrayUrl": "string",
            "fileAccessRevision": 1
          }
        ],
        "total": 1
      },
      "processing": {
        "documents": [
          {
            "documentId": "string",
            "fileAccess": {
              "mode": "public",
              "urlTtlSeconds": 1
            },
            "effectiveFileAccess": {
              "mode": "public",
              "urlTtlSeconds": 1
            },
            "bucketId": 1,
            "created": "2024-01-15T09:30:00Z",
            "deliveryStatus": "not_configured",
            "extractionProvenance": {
              "artifactRevision": "string",
              "runtimeBuildIds": [
                "string"
              ],
              "schemaHash": "string",
              "workflowId": "string",
              "workflowVersion": "string"
            },
            "extractionReady": true,
            "retryAvailable": true,
            "fileName": "string",
            "fileSize": "1.4MB",
            "fileType": "bmp",
            "filter": {
              "key": "value",
              "another_key": {
                "nested": "value"
              }
            },
            "processId": "string",
            "processLevel": "none",
            "searchData": {},
            "sourceUrl": "string",
            "hostedSourceUrl": "string",
            "status": "queued",
            "statusMessage": "string",
            "textUrl": "string",
            "xrayUrl": "string",
            "fileAccessRevision": 1
          }
        ],
        "total": 1
      },
      "queued": {
        "documents": [
          {
            "documentId": "string",
            "fileAccess": {
              "mode": "public",
              "urlTtlSeconds": 1
            },
            "effectiveFileAccess": {
              "mode": "public",
              "urlTtlSeconds": 1
            },
            "bucketId": 1,
            "created": "2024-01-15T09:30:00Z",
            "deliveryStatus": "not_configured",
            "extractionProvenance": {
              "artifactRevision": "string",
              "runtimeBuildIds": [
                "string"
              ],
              "schemaHash": "string",
              "workflowId": "string",
              "workflowVersion": "string"
            },
            "extractionReady": true,
            "retryAvailable": true,
            "fileName": "string",
            "fileSize": "1.4MB",
            "fileType": "bmp",
            "filter": {
              "key": "value",
              "another_key": {
                "nested": "value"
              }
            },
            "processId": "string",
            "processLevel": "none",
            "searchData": {},
            "sourceUrl": "string",
            "hostedSourceUrl": "string",
            "status": "queued",
            "statusMessage": "string",
            "textUrl": "string",
            "xrayUrl": "string",
            "fileAccessRevision": 1
          }
        ],
        "total": 1
      }
    },
    "statusMessage": "string"
  }
}

Update document metadata or file-access settings. Change one document policy per request, without other attribute changes. Policy updates do not rerun processing.

Authentication

X-API-Keystring

API Key authentication via header

Request

This endpoint expects an object.

documentslist of objectsRequired

callbackUrlstringOptionalformat: "uri"

URL that receives processing updates as POST requests.

callbackDatastringOptional

Custom string included in processing updates sent to the callback URL.

Response

Documents successfully submitted for updates

ingestobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

503

Service Unavailable Error