App integration

Connect an application to the Docpipe service.

App Integration

Run Docpipe as a shared internal API or alongside one application. Operators provide TLS, ingress, and secrets; each client supplies its own vector-store connection and model configuration.

Source: Integration and deployment guide

Python HTTP client

from docpipe.client.integration import DocpipeClient

with DocpipeClient(
    "http://docpipe.docpipe.svc.cluster.local:8000",
    username="admin",
    password="<secret-from-your-secret-manager>",
) as client:
    print(client.available_preset_names())
    client.ingest(
        source="invoice.pdf",
        connection_string="postgresql://app:<secret>@database:5432/app",
        table_name="documents",
        embedding_provider="openai",
        embedding_model="text-embedding-3-small",
        preset="balanced",
    )

Runtime preset	Use
fast	Lower-latency parser and chunk defaults
balanced	General-purpose default
quality	OCR and stronger reranking options
agents	Agentic RAG when the AutoGen integration is installed

Compose example: `examples/internal-shared` in the Docpipe repository (no bundled Postgres; each client provides its own connection string).
The `X-Docpipe-Tenant-Id` header is trusted only when the deployment configures an authenticated tenant mapping; Docpipe does not issue tenant tokens.
For object storage, configure the S3 source plugin's operator-owned allowlists and credential references. Private URL access is a separate setting and should only be enabled for trusted networks.
Read the Docpipe internal security guide before exposing the service beyond a trusted network.