> 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.

# cancel_process

DELETE https://api.groundx.ai/api/v1/ingest/{processId}

Cancel an ingest process, along with any files that have not been completely ingested.


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

## Authentication

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

## Request

### Path parameters

- `processId` (string, required) — the processId for the ingest process to be cancelled

## Response

### 200

Cancel success

- `ingest` (IngestStatus, required)

## Errors

### 400 Bad Request Error

Invalid process ID

- `any`

### 401 Unauthorized Error

Unauthorized to access process with given ID

- `any`

## Types

### IngestStatus

- `processId` (string, required)
- `status` (enum, required)
  - Allowed values: `queued`, `training`, `generating`, `processing`, `error`, `complete`, `cancelled`, `active`, `inactive`
- `id` (integer, optional)
- `progress` (IngestStatusProgress, optional)
- `statusMessage` (string, optional)

### IngestStatusProgress

- `cancelled` (IngestStatusProgressCancelled, optional)
- `complete` (IngestStatusProgressComplete, optional)
- `errors` (IngestStatusProgressErrors, optional)
- `processing` (IngestStatusProgressProcessing, optional)
- `queued` (IngestStatusProgressQueued, optional)

### IngestStatusProgressCancelled

- `documents` (list of DocumentDetail, optional)
- `total` (integer, optional)

### IngestStatusProgressComplete

- `documents` (list of DocumentDetail, optional)
- `total` (integer, optional)

### IngestStatusProgressErrors

- `documents` (list of DocumentDetail, optional)
- `total` (integer, optional)

### IngestStatusProgressProcessing

- `documents` (list of DocumentDetail, optional)
- `total` (integer, optional)

### IngestStatusProgressQueued

- `documents` (list of DocumentDetail, optional)
- `total` (integer, optional)

### 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.
- `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
- `fileAccessRevision` (integer, optional, deprecated) — Legacy compatibility field. Not required or checked when changing file access.

### FileAccessPolicy

For each field, document settings take priority over bucket settings, then account settings. Omitted fields use the broader value. Explicit public mode and longer sharing lifetimes are allowed. Stable public links never expire. urlTtlSeconds limits new sharing links; an issued link works without API credentials until its storage expiry.

- `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

**Response**

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

**SDK Code**

```python
import requests

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

headers = {"X-API-Key": "<apiKey>"}

response = requests.delete(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.groundx.ai/api/v1/ingest/processId';
const options = {method: 'DELETE', headers: {'X-API-Key': '<apiKey>'}};

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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-API-Key", "<apiKey>")

	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/processId")

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

request = Net::HTTP::Delete.new(url)
request["X-API-Key"] = '<apiKey>'

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.delete("https://api.groundx.ai/api/v1/ingest/processId")
  .header("X-API-Key", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.groundx.ai/api/v1/ingest/processId', [
  'headers' => [
    'X-API-Key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.groundx.ai/api/v1/ingest/processId");
var request = new RestRequest(Method.DELETE);
request.AddHeader("X-API-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.groundx.ai/api/v1/ingest/processId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers

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()
```