> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.eyelevel.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.eyelevel.ai/_mcp/server.

# get

GET https://api.groundx.ai/api/v1/ingest/document/{documentId}

Look up an existing document by documentId.


Reference: https://docs.eyelevel.ai/reference/api-reference/documents/get

## Authentication

- `X-API-Key` header (required) — API Key authentication via header

## Request

### Path parameters

- `documentId` (string, required) — The documentId of the document for which GroundX information will be provided.

## Response

### 200

Lookup successful

- `document` (DocumentDetail, optional)

## Errors

### 400 Bad Request Error

Invalid document ID

- `any`

### 401 Unauthorized Error

Unauthorized to access document with given ID

- `any`

## Types

### DocumentDetail

- `documentId` (string, required) — Unique system generated ID for the document
- `fileAccess` (FileAccessPolicy, optional, nullable) — Applied settings for this resource. Null means it inherits settings. Deployments without file access omit this field. Pending changes are not returned.
- `fileAccessRevision` (integer, optional) — Current settings revision. Include it when updating fileAccess. A stale revision returns 409.
- `effectiveFileAccess` (EffectivePolicy, optional) — Applied settings after inheritance. Sharing links expire after 300 seconds by default; storage credentials may shorten that time. Protected stable URLs require current authentication on every read.
- `bucketId` (integer, optional)
- `created` (string, optional) — Document creation time in RFC 3339 format, when available.
- `deliveryStatus` (enum, optional) — Delivery confirmation for the current run. Failure does not prove the receiver received nothing. Unknown means the saved evidence cannot confirm delivery.
  - Allowed values: `not_configured`, `pending`, `succeeded`, `failed`, `unknown`
- `extractionProvenance` (ExtractionProvenance, optional) — Workflow and runtime builds associated with the document's current extraction result.
- `extractionReady` (boolean, optional) — Whether the current run's final extraction was published after required review and transformations. Null means saved evidence cannot confirm publication.
- `retryAvailable` (boolean, optional) — Whether the document can currently restart its failed HTTP callback. Returned by document detail only. GroundX rechecks eligibility when retry is requested.
- `fileName` (string, optional)
- `fileSize` (string, optional) — The file size of the file stored in GroundX
- `fileType` (enum, optional) — The type of document (one of the currently supported file types)
  - Allowed values: `bmp`, `csv`, `docx`, `gif`, `heif`, `hwp`, `ico`, `jpg`, `json`, `pdf`, `png`, `pptx`, `svg`, `tiff`, `tsv`, `txt`, `xlsx`, `webp`
- `filter` (DocumentDetailFilter, optional) — Key-value metadata used to filter documents before searching.
- `processId` (string, optional) — Unique system generated ID for the ingest request
- `processLevel` (enum, optional) — Processing level. 'none' extracts and chunks text. 'full', the default, also uses agents to create metadata for each chunk.
  - Allowed values: `none`, `full`
- `searchData` (DocumentDetailSearchData, optional)
- `sourceUrl` (string, optional) — Source document URL
- `hostedSourceUrl` (string, optional) — GroundX-hosted stored source URL, when available. Returned by document detail only; access still requires normal document authorization.
- `status` (enum, optional)
  - Allowed values: `queued`, `training`, `generating`, `processing`, `error`, `complete`, `cancelled`, `active`, `inactive`
- `statusMessage` (string, optional)
- `textUrl` (string, optional) — Extracted text URL, if using the extract agent
- `xrayUrl` (string, optional) — Document X-Ray results

### FileAccessPolicy

Settings that override inherited values. Omitted fields inherit. A protected parent cannot be made public, and its sharing time limit cannot be exceeded. Stable public links never expire. urlTtlSeconds limits the lifetime of storage-signed sharing links.

- `mode` (enum, optional)
  - Allowed values: `public`, `protected`
- `urlTtlSeconds` (integer, optional)

### EffectivePolicy

Applied settings after inheritance. Sharing links expire after 300 seconds by default; storage credentials may shorten that time. Protected stable URLs require current authentication on every read.

- `mode` (enum, required)
  - Allowed values: `public`, `protected`
- `urlTtlSeconds` (integer, required)

### ExtractionProvenance

Workflow and runtime builds associated with the document's current extraction result.

- `artifactRevision` (string, optional) — Revision of the complete deployed workflow artifact, including prompts.
- `runtimeBuildIds` (list of string, optional) — Unique extraction container build IDs observed while producing the current result. Each ID maps to one immutable image digest.
- `schemaHash` (string, optional) — Hash of the workflow output schema and routing metadata.
- `workflowId` (string, optional) — Unique system generated ID for the extraction workflow.
- `workflowVersion` (string, optional) — Exact workflow version selected when extraction was dispatched.

### DocumentDetailFilter

Key-value metadata used to filter documents before searching.

### DocumentDetailSearchData

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "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"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.groundx.ai/api/v1/ingest/document/documentId"

payload = {}
headers = {
    "X-API-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.groundx.ai/api/v1/ingest/document/documentId';
const options = {
  method: 'GET',
  headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.groundx.ai/api/v1/ingest/document/documentId"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("X-API-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.groundx.ai/api/v1/ingest/document/documentId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.groundx.ai/api/v1/ingest/document/documentId")
  .header("X-API-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.groundx.ai/api/v1/ingest/document/documentId', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.groundx.ai/api/v1/ingest/document/documentId");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-API-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.groundx.ai/api/v1/ingest/document/documentId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```