---
title: "Ingest uploaded document"
method: POST
path: "/uploads/{upload_ids}/ingest"
tags: ["Document Ingestion"]
---

# Ingest uploaded document

`POST /uploads/{upload_ids}/ingest`

## Request

- Base URL: `https://h2ogpte.genai.h2o.ai/api/v1`
- URL: `https://h2ogpte.genai.h2o.ai/api/v1/uploads/{upload_ids}/ingest`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/h2o/apis/h2ogpte-rest-api/docs/uploads/:upload_ids/ingest/post.ts> (a function with typed inputs; its response is checked against the schema)

Ingests uploaded document identified to a given collection

## Path parameters

- `upload_ids` string[], required

## Query parameters

- `collection_id` string, required
- `gen_doc_summaries` boolean
- `gen_doc_questions` boolean
- `audio_input_language` string
- `ocr_model` string
- `tesseract_lang` string
- `keep_tables_as_one_chunk` boolean
- `chunk_by_page` boolean
- `handwriting_check` boolean
- `ingest_mode` 'standard' | 'agent_only'
- `restricted` boolean
- `permissions` string[]
- `encrypt_document` boolean
- `timeout` number, double

## Request body

- IngestUploadBody
  - `metadata` object: Metadata for the document.

## Response `204`

Successful operation

## Other responses

- `400`: Bad request
- `401`: Unauthorized - Invalid or missing API key
- `default`: Unexpected error

---

[API](https://skmtc.dev/h2o/apis/h2ogpte-rest-api.md) - [All operations](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/revisions/a82a117320f4?raw)