For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign Up
DocumentationAPI ReferenceSDKs
DocumentationAPI ReferenceSDKs
  • Documents
    • Ingest Documents
    • Ingest Directories
    • POSTcrawl_website
    • GETget_processing_status_by_id
    • GETlist
    • GETget
    • GETlookup
    • DELdelete (singular)
    • DELdelete (multiple)
    • GETget_processes
    • POSTcopy
    • PUTupdate
    • DELcancel_process
    • GETget_extract
    • GETget_xray
  • Search
    • POSTsearch.content
    • POSTsearch.documents
  • Buckets
    • GETlist
    • GETget
    • POSTcreate
    • PUTupdate
    • DELdelete
  • Groups
    • GETlist
    • GETget
    • POSTcreate
    • PUTupdate
    • DELdelete
    • POSTaddBucket
    • DELremoveBucket
  • Workflows
    • GETlist
    • POSTcreate
    • GETget_account
    • POSTadd_to_account
    • DELremove_from_account
    • POSTadd_to_id
    • DELremove_from_id
    • GETget
    • PUTupdate
    • DELdelete
  • Customer
    • GETget
  • API Key
    • GETlist
    • POSTcreate
    • PUTupdate
    • DELdelete
  • Health
    • GETlist
    • GETget
Sign Up
LogoLogo
Documents

Ingesting Directories

Python
1from groundx import GroundX
2
3client = GroundX(
4 api_key="YOUR_API_KEY",
5)
6client.ingest_directory(
7 bucket_id=1234,
8 path="/path/to/directory",
9)
Previous

crawl_website

Next
Built with

If you are using our Python SDK, there is an ingest_directory method that can be used to ingest a folder of local documents.

Supported Document Types and Ingest Capacities

ingest_directory

bucket_id
integerRequired

The bucket ID of the bucket which the files will be ingested to.

path
stringRequired

The local file directory path being ingested by GroundX.

batch_size
integer

The number of files submitted with each ingest request. Default is 10. Can be between 1 to 50 for paid subscriptions or 1 to 25 for free trial accounts.

upload_api
string

An endpoint that generates pre-signed requests for file uploads. Default is the EyeLevel.ai upload API.