Skip to main content

pipeshub-sdk

pipeshub-sdk is the official python client library for integrating Pipeshub into your product and internal tools

Compatibility: SDK version 1.7.0 is compatible with PipesHub v0.9.1.

Summary

PipesHub API: Unified API documentation for PipesHub services.

PipesHub is an enterprise-grade platform providing:

  • User authentication and management
  • Document storage and version control
  • Knowledge base management
  • Enterprise search and conversational AI
  • Third-party integrations via connectors
  • System configuration management
  • Crawling job scheduling
  • Email services

Authentication

Most endpoints require JWT Bearer token authentication. Some internal endpoints use scoped tokens for service-to-service communication.

OAuth 2.0 Bearer tokens from POST /oauth2/token use the same Authorization: Bearer header. For client_credentials, machine tokens may encode userId === client_id in the JWT; the Node API gateway resolves the OAuth app creator and sets the authenticated user accordingly. See the OAuth Provider tag for full behavior.

Base URLs

All endpoints use the /api/v1 prefix unless otherwise noted.

Table of Contents

SDK Installation

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add pipeshub-sdk

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install pipeshub-sdk

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add pipeshub-sdk

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from pipeshub-sdk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.10"
# dependencies = [
#     "pipeshub-sdk",
# ]
# ///

from pipeshub_sdk import Pipeshub

sdk = Pipeshub(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

SDK Example Usage

Example

# Synchronous Example
from pipeshub_sdk import Pipeshub


with Pipeshub() as pipeshub:

    res = pipeshub.o_auth_provider.oauth_token(grant_type="client_credentials")

    # Handle response
    print(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from pipeshub_sdk import Pipeshub

async def main():

    async with Pipeshub() as pipeshub:

        res = await pipeshub.o_auth_provider.oauth_token_async(grant_type="client_credentials")

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name Type Scheme Environment Variable
bearer_auth http HTTP Bearer PIPESHUB_BEARER_AUTH
oauth2 oauth2 OAuth2 token PIPESHUB_OAUTH2

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import os
from pipeshub_sdk import Pipeshub, models


with Pipeshub(
    security=models.Security(
        bearer_auth=os.getenv("PIPESHUB_BEARER_AUTH", ""),
    ),
) as pipeshub:

    res = pipeshub.o_auth_provider.oauth_token(grant_type="client_credentials")

    # Handle response
    print(res)

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import os
from pipeshub_sdk import Pipeshub, models


with Pipeshub() as pipeshub:

    res = pipeshub.user_account.refresh_token(security=models.RefreshTokenSecurity(
        scoped_token=os.getenv("PIPESHUB_SCOPED_TOKEN", ""),
    ))

    # Handle response
    print(res)

Available Resources and Operations

Available methods

Agents

AIModelsProviders

Connector

Conversations

KnowledgeBase

KnowledgeHub

OAuthApps

OAuthProvider

OpenIDConnect

OrganizationAuthConfig

Organizations

PersonalAccessTokens

Projects

SemanticSearch

UserAccount

WebSearch

Server-sent event streaming

Server-sent events are used to stream content from certain operations. These operations will expose the stream as Generator that can be consumed using a simple for loop. The loop will terminate when the server no longer has any events to send and closes the underlying connection.

The stream is also a Context Manager and can be used with the with statement and will close the underlying connection when the context is exited.

import os
from pipeshub_sdk import Pipeshub, models


with Pipeshub(
    security=models.Security(
        bearer_auth=os.getenv("PIPESHUB_BEARER_AUTH", ""),
    ),
) as pipeshub:

    res = pipeshub.knowledge_base.upload_records(kb_id="<id>", files=[], files_metadata="[{\"file_path\":\"/docs/report.pdf\",\"last_modified\":\"2024-01-15T10:30:00Z\"}]", is_versioned=True, record_type="FILE")

    with res as event_stream:
        for event in event_stream:
            # handle event
            print(event, flush=True)

File uploads

Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

import os
from pipeshub_sdk import Pipeshub, models


with Pipeshub(
    security=models.Security(
        bearer_auth=os.getenv("PIPESHUB_BEARER_AUTH", ""),
    ),
) as pipeshub:

    res = pipeshub.knowledge_base.update_record(record_id="<id>")

    # Handle response
    print(res)

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from pipeshub_sdk import Pipeshub
from pipeshub_sdk.utils import BackoffStrategy, RetryConfig


with Pipeshub() as pipeshub:

    res = pipeshub.o_auth_provider.oauth_token(grant_type="client_credentials",
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from pipeshub_sdk import Pipeshub
from pipeshub_sdk.utils import BackoffStrategy, RetryConfig


with Pipeshub(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) as pipeshub:

    res = pipeshub.o_auth_provider.oauth_token(grant_type="client_credentials")

    # Handle response
    print(res)

Error Handling

PipeshubError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
err.message str Error message
err.status_code int HTTP response status code eg 404
err.headers httpx.Headers HTTP response headers
err.body str HTTP body. Can be empty string if no body is returned.
err.raw_response httpx.Response Raw HTTP response
err.data Optional. Some errors may contain structured data. See Error Classes.

Example

from pipeshub_sdk import Pipeshub, errors


with Pipeshub() as pipeshub:
    res = None
    try:

        res = pipeshub.o_auth_provider.oauth_token(grant_type="client_credentials")

        # Handle response
        print(res)


    except errors.PipeshubError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.ErrorResponse):
            print(e.data.error)  # models.ErrorResponseError

Error Classes

Primary error:

Less common errors (33)

Network errors:

Inherit from PipeshubError:

  • ErrorResponse: Standard error envelope returned by all errors routed through ErrorMiddleware. Applies to all BaseError subclasses including HttpError, ValidationError, and others. The code field is a machine-readable string identifying the error type (e.g. HTTP_UNAUTHORIZED, HTTP_NOT_FOUND, VALIDATION_ERROR, INTERNAL_ERROR). Applicable to 44 of 122 methods.*
  • OAuthClientManagementRateLimitError: JSON body when OAuth client management routes exceed the per-minute rate limit (same limiter as other /oauth-clients/* routes). Status code 429. Applicable to 20 of 122 methods.*
  • ApplicationJSONErrorResponse: Standard JSON error envelope from ErrorMiddleware for BaseError subclasses (error.middleware.ts). Returned for most API 4xx errors (unauthorized, forbidden, not found, validation failures, etc.). Applicable to 17 of 122 methods.*
  • OAuthErrorResponse: OAuth 2.0 Error Response (RFC 6749 Section 5.2). Standard error format for OAuth endpoints. Status code 401. Applicable to 3 of 122 methods.*
  • GetKnowledgeHubRootNodesBadRequestError: Invalid request parameters. The backend's validation message is returned verbatim in error.message. See the examples below for the common triggers. Status code 400. Applicable to 1 of 122 methods.*
  • GetKnowledgeHubChildNodesBadRequestError: Invalid request parameters or path values. The backend's validation message is returned verbatim in error.message. See the examples below for the common triggers. Status code 400. Applicable to 1 of 122 methods.*
  • SearchHistoryBadRequestError: Error envelope for a failed request. Status code 400. Applicable to 1 of 122 methods.*
  • GetSearchByIDBadRequestError: Invalid request — searchId failed Zod validation (not a valid ObjectId). Status code 400. Applicable to 1 of 122 methods.*
  • DeleteAgentConversationChatAttachmentBadRequestError: Invalid or blank path params (agentKey or recordId). Status code 400. Applicable to 1 of 122 methods.*
  • GetAvailableModelsByTypeBadRequestError: Invalid modelType path parameter. The modelType value was not one of the supported enum categories. This response is produced by the Zod validation middleware before the handler runs. The error.metadata.errors array contains per-field detail about exactly which constraint failed. Status code 400. Applicable to 1 of 122 methods.*
  • GetKnowledgeHubRootNodesUnauthorizedError: Missing or invalid authentication token. The bearer token was absent, expired, malformed, or could not be verified by the auth middleware. Status code 401. Applicable to 1 of 122 methods.*
  • GetKnowledgeHubChildNodesUnauthorizedError: Missing or invalid authentication token. The bearer token was absent, expired, malformed, or could not be verified by the auth middleware. Status code 401. Applicable to 1 of 122 methods.*
  • SearchHistoryUnauthorizedError: Error envelope for a failed request. Status code 401. Applicable to 1 of 122 methods.*
  • GetSearchByIDUnauthorizedError: Missing or invalid bearer token. Status code 401. Applicable to 1 of 122 methods.*
  • GetAvailableModelsByTypeUnauthorizedError: Missing or invalid authentication token. The bearer token was absent, expired, malformed, or could not be verified by the auth middleware. Status code 401. Applicable to 1 of 122 methods.*
  • GetKnowledgeHubRootNodesForbiddenError: Insufficient OAuth scope. Only applies to OAuth tokens. The token did not carry the kb:read scope required by this endpoint. Regular (non-OAuth) JWT bearer tokens are not subject to scope enforcement and will not receive this error. Status code 403. Applicable to 1 of 122 methods.*
  • GetKnowledgeHubChildNodesForbiddenError: Insufficient OAuth scope. Only applies to OAuth tokens. The token did not carry the kb:read scope required by this endpoint. Regular (non-OAuth) JWT bearer tokens are not subject to scope enforcement and will not receive this error. Status code 403. Applicable to 1 of 122 methods.*
  • SearchHistoryForbiddenError: Error envelope for a failed request. Status code 403. Applicable to 1 of 122 methods.*
  • GetSearchByIDForbiddenError: Bearer token lacks the semantic:read scope. Status code 403. Applicable to 1 of 122 methods.*
  • GetAvailableModelsByTypeForbiddenError: Insufficient OAuth scope. Only applies to OAuth tokens. The token did not carry the config:read scope required by this endpoint. Regular (non-OAuth) JWT bearer tokens are not subject to scope enforcement and will not receive this error. Status code 403. Applicable to 1 of 122 methods.*
  • StreamRecordErrorResponse: Error payload returned by the legacy record-stream proxy when the downstream streaming request fails after route middleware has passed. Applicable to 1 of 122 methods.*
  • GetKnowledgeHubChildNodesNotFoundError: Parent node not found. The parentId does not correspond to an existing node of the specified parentType, or the node has been deleted. Status code 404. Applicable to 1 of 122 methods.*
  • GetSearchByIDNotFoundError: Reserved for parity with sibling routes; this endpoint currently returns 200 with an empty array for an unknown id rather than emitting 404. Status code 404. Applicable to 1 of 122 methods.*
  • GetKnowledgeHubRootNodesInternalServerError: An unexpected error occurred on the server. Status code 500. Applicable to 1 of 122 methods.*
  • GetKnowledgeHubChildNodesInternalServerError: An unexpected error occurred on the server. Status code 500. Applicable to 1 of 122 methods.*
  • SearchHistoryInternalServerError: Error envelope for a failed request. Status code 500. Applicable to 1 of 122 methods.*
  • GetSearchByIDInternalServerError: Server error. Possible causes: - Explicit InternalServerError or any other 500 BaseError thrown by the handler. - Non-BaseError exception caught by the global error middleware. - Response serializer fallback. Status code 500. Applicable to 1 of 122 methods.*
  • GetAvailableModelsByTypeInternalServerError: An unexpected error occurred on the server. Status code 500. Applicable to 1 of 122 methods.*
  • ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables Description
0 https://{instance_url}/api/v1 instance_url Base API URL
1 https://{instance_url} instance_url Root URL (used for MCP endpoints mounted at /mcp)

If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:

Variable Parameter Default Description
instance_url instance_url: str "https://app.pipeshub.com" Base server URL

Example

from pipeshub_sdk import Pipeshub


with Pipeshub(
    server_idx=0,
    instance_url="https://app.pipeshub.com",
) as pipeshub:

    res = pipeshub.o_auth_provider.oauth_token(grant_type="client_credentials")

    # Handle response
    print(res)

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from pipeshub_sdk import Pipeshub


with Pipeshub(
    server_url="https://https://app.pipeshub.com",
) as pipeshub:

    res = pipeshub.o_auth_provider.oauth_token(grant_type="client_credentials")

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from pipeshub_sdk import Pipeshub
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Pipeshub(client=http_client)

or you could wrap the client with your own custom logic:

from pipeshub_sdk import Pipeshub
from pipeshub_sdk.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = Pipeshub(async_client=CustomClient(httpx.AsyncClient()))

httpx2 (Pydantic's httpx fork)

httpx2 is Pydantic's maintained fork of httpx. To run this SDK on httpx2, call alias_httpx() at your program's entry point, before importing the SDK, so every import httpx — including the ones inside the SDK — resolves to httpx2:

import httpx2

httpx2.alias_httpx()

from pipeshub_sdk import Pipeshub

s = Pipeshub()

An SDK can also be generated against httpx2 directly, so it depends on the fork instead of httpx, by setting python.httpClientLibrary: httpx2 in gen.yaml.

Resource Management

The Pipeshub class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from pipeshub_sdk import Pipeshub
def main():

    with Pipeshub() as pipeshub:
        # Rest of application here...


# Or when using async:
async def amain():

    async with Pipeshub() as pipeshub:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from pipeshub_sdk import Pipeshub
import logging

logging.basicConfig(level=logging.DEBUG)
s = Pipeshub(debug_logger=logging.getLogger("pipeshub_sdk"))

You can also enable a default debug logger by setting an environment variable PIPESHUB_DEBUG to true.

Metadata

Release files for pipeshub-sdk 1.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pipeshub-sdk 1.7.0
File Size Uploaded Provenance Actions
pipeshub_sdk-1.7.0.tar.gz 355.9 kB Without provenance Details for pipeshub_sdk-1.7.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pipeshub-sdk 1.7.0
File Interpreter ABI Platform Actions
pipeshub_sdk-1.7.0-py3-none-any.whl Python 3 none any Details for pipeshub_sdk-1.7.0-py3-none-any.whl

Total release size: 940.9 kB

Release files / pipeshub_sdk-1.7.0.tar.gz

Download URL pipeshub_sdk-1.7.0.tar.gz
Size 355.9 kB
Tags Source
SHA-256 checksum
How to use checksums
7f18dcc91b7d024f4e95ed05fc1bb34e6ae892ec919fd5c1a40ecdb7ef640834
BLAKE2b-256 checksum
How to use checksums
1d8deaa0bd99ec27edbae9514efb5e100919f749762051aab30f4879c928b09e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / pipeshub_sdk-1.7.0-py3-none-any.whl

Download URL pipeshub_sdk-1.7.0-py3-none-any.whl
Size 585.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9ca4dac550d4a166c77ccfaae55e30b883af4df0264cb3c59dbd129072f29082
BLAKE2b-256 checksum
How to use checksums
1dd991180ee739fdfbee8fdca3a4040cd59e85fdae2ed7994072b5c0617b6adf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for pipeshub-sdk 1.7.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page