get | Documentation

{
  "document": {
    "documentId": "a3f1c2d4-e5b6-7890-abcd-ef1234567890",
    "fileAccess": {
      "mode": "protected",
      "urlTtlSeconds": 3600
    },
    "fileAccessRevision": 2,
    "effectiveFileAccess": {
      "mode": "protected",
      "urlTtlSeconds": 3600
    },
    "bucketId": 1042,
    "created": "2024-01-15T09:30:00Z",
    "deliveryStatus": "succeeded",
    "extractionProvenance": {
      "artifactRevision": "v2.4.1-20240115",
      "runtimeBuildIds": [
        "extraction-worker:sha256:abc123def456"
      ],
      "schemaHash": "sha256:9f86d081884c7d659a2feaa0c55ad015",
      "workflowId": "wf-7d3e2a1b-4c5f-6e7d-8a9b-0c1d2e3f4a5b",
      "workflowVersion": "3.1.0"
    },
    "extractionReady": true,
    "retryAvailable": false,
    "fileName": "annual_report_2024.pdf",
    "fileSize": "1.4MB",
    "fileType": "pdf",
    "filter": {
      "key": "annual_report",
      "another_key": {
        "nested": "finance"
      }
    },
    "processId": "b7e2d4f6-a1c3-4e5f-9b8d-2c7a0e1f3d5b",
    "processLevel": "full",
    "searchData": {},
    "sourceUrl": "https://storage.example.com/documents/annual_report_2024.pdf",
    "hostedSourceUrl": "https://api.groundx.ai/api/v1/ingest/document/a3f1c2d4-e5b6-7890-abcd-ef1234567890/source",
    "status": "complete",
    "statusMessage": "Document successfully processed and indexed.",
    "textUrl": "https://api.groundx.ai/api/v1/ingest/document/a3f1c2d4-e5b6-7890-abcd-ef1234567890/text",
    "xrayUrl": "https://api.groundx.ai/api/v1/ingest/document/a3f1c2d4-e5b6-7890-abcd-ef1234567890/xray"
  }
}

Look up an existing document by documentId.

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

documentIdstringRequiredformat: "uuid"

The documentId of the document for which GroundX information will be provided.

Response

Lookup successful

documentobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error