---
title: "ingest_local"
method: POST
path: "/v1/ingest/documents/local"
tags: ["Documents"]
---

# ingest_local

`POST /v1/ingest/documents/local`

Upload documents hosted on a local file system for ingestion into a GroundX bucket.

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

## Response `200`

Documents successfully uploaded

- IngestResponse
  - `ingest` object, required
    - `processId` string, uuid, required
    - `status` 'queued' | 'processing' | 'error' | 'complete' | 'cancelled', required

## Other responses

- `400` — Invalid document type or source URL
- `401` — Unauthorized to update bucket with ID

## Changes

- **2024-07-16** `fc97f6aaa747` — 1 info
  - api operation id `Document_uploadLocal` removed and replaced with `Document_ingestLocal`
- **2024-02-01** `bc7318def107` — 1 info
  - added the new `json` enum value to the request property `items/metadata/fileType`
- **2023-12-31** `4c5920188a7d` — 2 info
  - added the new `csv` enum value to the request property `items/metadata/fileType`
  - added the new `tsv` enum value to the request property `items/metadata/fileType`
- **2023-11-29** `3bb565058636` — 3 warning, 1 info
  - removed the request property `items/metadata/callbackData`
  - removed the request property `items/metadata/callbackUrl`
  - removed the request property `items/metadata/metadata`
  - added the new optional request property `items/metadata/searchData`
- **2023-11-29** `bf7061385e18` — 1 breaking, 1 warning
  - the `items/metadata/callbackUrl` request property format changed from no format to `uri`
  - added the new `cancelled` enum value to the `ingest/status` response property for the response status `200`

[Full history](https://skmtc.dev/groundxai/apis/groundx-apis/changes/v1/ingest/documents/local/post.md)

---

[API](https://skmtc.dev/groundxai/apis/groundx-apis.md) · [All operations](https://skmtc.dev/groundxai/apis/groundx-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/groundxai/apis/groundx-apis/revisions/1c1a5c17f52f?raw)