ingest - Remote Documents | Documentation

Ingest documents hosted on public URLs into a GroundX bucket. [Supported Document Types and Ingest Capacities](https://docs.eyelevel.ai/documentation/fundamentals/document-types-and-ingest-capacities)

Ingest documents hosted on public URLs into a GroundX bucket.

Supported Document Types and Ingest Capacities

Authentication

X-API-Keystring

API Key authentication via header

Request

This endpoint expects an object.

documentslist of objectsRequired

callbackUrlstringOptionalformat: "uri"

An endpoint that will receive processing event updates as POST.

callbackDatastringOptional

A string that is returned, along with processing event updates, to the callback URL.

Response

Documents successfully uploaded

ingestobject

Errors

400

Bad Request Error

401

Unauthorized Error

Ingest documents hosted on public URLs into a GroundX bucket.

Supported Document Types and Ingest Capacities

API Key authentication via header

This endpoint expects an object.

An endpoint that will receive processing event updates as POST.

A string that is returned, along with processing event updates, to the callback URL.

Documents successfully uploaded

1	from groundx import Document, GroundX
2
3	client = GroundX(api_key="YOUR_API_KEY")
4
5	client.ingest(
6	documents=[
7	Document(
8	bucket_id=1234,
9	file_name="my_file1.txt",
10	file_path="https://my.source.url.com/file1.txt",
11	file_type="txt",
12	search_data=dict(
13	key = "value",
14	),
15	)
16	]
17	)

1	from groundx import Document, GroundX
2
3	client = GroundX(api_key="YOUR_API_KEY")
4
5	client.ingest(
6	documents=[
7	Document(
8	bucket_id=1234,
9	file_name="my_file1.txt",
10	file_path="https://my.source.url.com/file1.txt",
11	file_type="txt",
12	search_data=dict(
13	key = "value",
14	),
15	)
16	]
17	)