---
title: "Ingests confluence pages into collection."
method: POST
path: "/ingest/confluence"
tags: ["Document Ingestion"]
---

# Ingests confluence pages into collection.

`POST /ingest/confluence`

## Request

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

Ingests confluence pages into collection. If an ingested page has sub-pages, the subpages are also ingested.

## 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'
- `timeout` number, double

## Request body

- IngestFromConfluenceBody
  - `base_url` string, required: Base url of the confluence instance.
  - `page_ids` string[], required: Ids of pages to be ingested.
  - `include_attachments` boolean: A flag indicating whether to also ingest attachments with the page.
  - `credentials` ConfluenceCredentials, required: The object with Confluence credentials.
    - `username` string, required: Name or email of the user.
    - `password` string, required: Password or API token.
  - `metadata` object: Metadata for the documents.

## 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)