delete (singular) | Documentation

from groundx import GroundX
client = GroundX(
    api_key="YOUR_API_KEY_HERE",
)
client.documents.delete_by_id(
    document_id="documentId",
)

{
  "ingest": {
    "processId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "status": "complete",
    "id": 42,
    "progress": {
      "cancelled": {
        "documents": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "bucketId": 7,
            "fileName": "cancelled_report.pdf",
            "fileSize": "2.3MB",
            "fileType": "pdf",
            "filter": {
              "category": "finance",
              "year": 2023
            },
            "processId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "processLevel": "none",
            "searchData": {},
            "sourceUrl": "https://example.com/docs/cancelled_report.pdf",
            "status": "cancelled",
            "statusMessage": "Document processing was cancelled by user",
            "textUrl": "https://storage.groundx.ai/texts/cancelled_report.txt",
            "xrayUrl": "https://storage.groundx.ai/xray/cancelled_report.json"
          }
        ],
        "total": 1
      },
      "complete": {
        "documents": [
          {
            "documentId": "1c6b147a-3f3a-4a2a-9f3e-8a1b2c3d4e5f",
            "bucketId": 7,
            "fileName": "annual_summary_2023.xlsx",
            "fileSize": "1.4MB",
            "fileType": "xlsx",
            "filter": {
              "department": "sales",
              "quarter": "Q4"
            },
            "processId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "processLevel": "full",
            "searchData": {},
            "sourceUrl": "https://example.com/docs/annual_summary_2023.xlsx",
            "status": "complete",
            "statusMessage": "Document processed successfully",
            "textUrl": "https://storage.groundx.ai/texts/annual_summary_2023.txt",
            "xrayUrl": "https://storage.groundx.ai/xray/annual_summary_2023.json"
          }
        ],
        "total": 1
      },
      "errors": {
        "documents": [
          {
            "documentId": "7b9f3c2d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
            "bucketId": 7,
            "fileName": "corrupted_data.csv",
            "fileSize": "0.9MB",
            "fileType": "csv",
            "filter": {
              "source": "external",
              "priority": "high"
            },
            "processId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "processLevel": "full",
            "searchData": {},
            "sourceUrl": "https://example.com/docs/corrupted_data.csv",
            "status": "error",
            "statusMessage": "File corrupted during upload",
            "textUrl": "https://storage.groundx.ai/texts/corrupted_data.txt",
            "xrayUrl": "https://storage.groundx.ai/xray/corrupted_data.json"
          }
        ],
        "total": 1
      },
      "processing": {
        "documents": [
          {
            "documentId": "9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f",
            "bucketId": 7,
            "fileName": "project_plan.pptx",
            "fileSize": "3.1MB",
            "fileType": "pptx",
            "filter": {
              "team": "development",
              "phase": "planning"
            },
            "processId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "processLevel": "full",
            "searchData": {},
            "sourceUrl": "https://example.com/docs/project_plan.pptx",
            "status": "processing",
            "statusMessage": "Currently processing document",
            "textUrl": "https://storage.groundx.ai/texts/project_plan.txt",
            "xrayUrl": "https://storage.groundx.ai/xray/project_plan.json"
          }
        ],
        "total": 1
      },
      "queued": {
        "documents": [
          {
            "documentId": "2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
            "bucketId": 7,
            "fileName": "meeting_notes.txt",
            "fileSize": "0.2MB",
            "fileType": "txt",
            "filter": {
              "meeting": "weekly_sync",
              "date": "2024-04-20"
            },
            "processId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "processLevel": "none",
            "searchData": {},
            "sourceUrl": "https://example.com/docs/meeting_notes.txt",
            "status": "queued",
            "statusMessage": "Document queued for processing",
            "textUrl": "https://storage.groundx.ai/texts/meeting_notes.txt",
            "xrayUrl": "https://storage.groundx.ai/xray/meeting_notes.json"
          }
        ],
        "total": 1
      }
    },
    "statusMessage": "Document deletion completed successfully"
  }
}

Delete a single document hosted on GroundX

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

documentIdstringRequiredformat: "uuid"

A documentId which correspond to a document ingested by GroundX

Response

Document successfully deleted

ingestobject

Errors

400

Bad Request Error

401

Unauthorized Error