---
id: groundx
version: "3.9.7"
license: MIT
license_treatment: permissive
maintenance: active
---

# groundx

License: permissive · Maintenance: active · Downloads: 97.7K/mo

## What it is and what it does

GroundX is a Python SDK that wraps the GroundX API, a document ingestion and extraction service. It provides both synchronous and asynchronous clients for uploading documents to buckets, managing extraction workflows defined in YAML, and retrieving results. The library handles common HTTP concerns—automatic retries on 408, 429, and 5xx responses, configurable timeouts (default 60 seconds), and custom httpx client support for proxies and transports.

The package is designed for developers who need to programmatically ingest documents into GroundX or automate extraction workflows. It uses Pydantic for request/response validation and includes exception handling for API errors. An optional [extract] extra provides workflow helpers for creating, updating, and loading extraction definitions from YAML files.

Use it for:

- Ingest documents into GroundX buckets from a Python application with automatic retry handling.
- Create and manage extraction workflows from YAML definitions to automate document processing.
- Build async-first applications that make non-blocking calls to the GroundX API.
- Handle API errors and retries transparently without manual retry logic.
- Customize HTTP behavior (proxies, timeouts, transports) for specific network environments.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

A Python client library for the GroundX API that handles document ingestion, extraction workflows, and API communication with built-in retry logic and async support.

Yes. The package is actively maintained (released within the last day), has low install friction, carries a permissive MIT license, and provides a clean, well-documented interface to the GroundX API. No known vulnerabilities. Install it if you need to integrate GroundX document ingestion or extraction workflows into a Python application.

## Install

pip install groundx
uv add groundx
poetry add groundx

## Installing groundx

Before you install: Low friction install with a pure-Python wheel. Actively maintained with a release within the last day. Depends on common, well-maintained libraries (httpx, pydantic, requests, tqdm) with no system-level requirements.

License in practice: MIT license permits commercial and private use with minimal restrictions—include a copy of the license and you're free to use, modify, and distribute.

Quickstart:

pip install groundx

from groundx import Document, GroundX

client = GroundX(api_key="YOUR_API_KEY")
client.ingest(documents=[Document(bucket_id=1234, file_name="file.txt", file_type="txt", source_url="https://example.com/file.txt")])

Requires Python 3.10 or later; a valid GroundX API key is needed to authenticate.

Verify before relying:

- Whether the extraction workflow feature (requiring the [extract] extra) is production-ready or still experimental.
- Performance characteristics and throughput limits for bulk document ingestion.
- Whether the async client is fully feature-parity with the sync client.

## Package facts

- License: MIT (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 97.7K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

groundx api client python, document ingestion sdk, extraction workflow automation, api client with retries, async http client library, document management api, yaml workflow configuration, api-client, document-processing, async-support

[View on SkillFed](https://skillfed.io/packages/groundx) · [View on PyPI](https://pypi.org/project/groundx/)