---
title: "Crawls and ingest a URL into a collection."
method: POST
path: "/ingest/website"
tags: ["Document Ingestion"]
---

# Crawls and ingest a URL into a collection.

`POST /ingest/website`

## Request

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

Crawls and ingest a URL into a collection. The web page or document linked from this URL will be imported.

## Query parameters

- `collection_id` string, required
- `follow_links` boolean
- `max_depth` integer
- `max_documents` integer
- `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

- IngestFromWebsiteBody
  - `url` string, required: String of the url to crawl.

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