Python Client SDK Generated by Speakeasy.

Project description

pipeshub-sdk

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

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, sets the authenticated user accordingly, and forwards x-oauth-user-id to Python services on proxied calls. Do not send x-oauth-user-id yourself—the gateway removes untrusted values on ingress. See the OAuth Provider tag for full behavior.

Base URLs

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

pipeshub-sdk

SDK Installation

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

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.

PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from pipeshub_sdk import Pipeshub


with Pipeshub() as pipeshub:

    res = pipeshub.user_account.init_auth(request={
        "email": "user@example.com",
    })

    # 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.user_account.init_auth_async(request={
            "email": "user@example.com",
        })

        # 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.user_account.init_auth(request={
        "email": "user@example.com",
    })

    # 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.reset_password_with_token(security=models.ResetPasswordWithTokenSecurity(
        scoped_token=os.getenv("PIPESHUB_SCOPED_TOKEN", ""),
    ), password="H9GEHoL829GXj06")

    # Handle response
    print(res)

Available Resources and Operations

Available methods

AIModelsProviders

get_available_models_by_type - Get available models by type

Conversations

stream_chat - Create conversation with streaming response
get_all_conversations - List all conversations
get_archived_conversations - List archived conversations
search_archived_conversations - Search archived conversations
get_conversation_by_id - Get conversation by ID
delete_conversation_by_id - Delete conversation
add_message_stream - Add message to a conversation with streaming response
update_conversation_title - Update conversation title
archive_conversation - Archive conversation
unarchive_conversation - Unarchive conversation
regenerate_answer - Regenerate AI response
update_message_feedback - Submit feedback on AI response

KnowledgeHub

get_knowledge_hub_root_nodes - Get knowledge hub root nodes
get_knowledge_hub_child_nodes - Get knowledge hub child nodes

OrganizationAuthConfig

get_auth_methods - Get organization authentication methods
update_auth_method - Update organization authentication methods
set_up_auth_config - Set up auth configuration

Organizations

get_current_organization - Get current organization

SemanticSearch

search - Perform semantic search
search_history - Get search history
delete_search_history - Clear all search history
get_search_by_id - Get search by ID
delete_search_by_id - Delete search by ID
archive_search - Archive a search
unarchive_search - Unarchive a search

UserAccount

init_auth - Initialize authentication session
authenticate - Authenticate user with credentials
reset_password_with_token - Reset password with email token
reset_password - Reset password

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
from pipeshub_sdk.utils import parse_datetime


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

    res = pipeshub.conversations.stream_chat(query="What are the key findings from our Q4 financial report?", record_ids=[
        "507f1f77bcf86cd799439011",
        "507f1f77bcf86cd799439012",
    ], model_key="gpt-4-turbo", model_name="GPT-4 Turbo", model_friendly_name="GPT-4 Turbo", chat_mode="balanced", timezone="America/New_York", current_time=parse_datetime("2026-04-12T16:00:00+05:30"), tools=[
        "jira.create_issue",
        "confluence.search_content",
    ])

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

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.user_account.init_auth(request={
        "email": "user@example.com",
    },
        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.user_account.init_auth(request={
        "email": "user@example.com",
    })

    # 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.user_account.init_auth(request={
            "email": "user@example.com",
        })

        # 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.Error

Error Classes

Primary error:

PipeshubError: The base class for HTTP error responses.

Less common errors (28)

Network errors:

httpx.RequestError: Base class for request errors.
- httpx.ConnectError: HTTP client was unable to make a request to a server.
- httpx.TimeoutException: HTTP request timed out.

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 7 of 30 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 30 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 30 methods.*
SearchHistoryBadRequestError: Error envelope for a failed request. Status code 400. Applicable to 1 of 30 methods.*
GetSearchByIDBadRequestError: Invalid request — searchId failed Zod validation (not a valid ObjectId). Status code 400. Applicable to 1 of 30 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 30 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 30 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 30 methods.*
SearchHistoryUnauthorizedError: Error envelope for a failed request. Status code 401. Applicable to 1 of 30 methods.*
GetSearchByIDUnauthorizedError: Missing or invalid bearer token. Status code 401. Applicable to 1 of 30 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 30 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 30 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 30 methods.*
SearchHistoryForbiddenError: Error envelope for a failed request. Status code 403. Applicable to 1 of 30 methods.*
GetSearchByIDForbiddenError: Bearer token lacks the semantic:read scope. Status code 403. Applicable to 1 of 30 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 30 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 30 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 30 methods.*
GetKnowledgeHubRootNodesInternalServerError: An unexpected error occurred on the server. Status code 500. Applicable to 1 of 30 methods.*
GetKnowledgeHubChildNodesInternalServerError: An unexpected error occurred on the server. Status code 500. Applicable to 1 of 30 methods.*
SearchHistoryInternalServerError: Error envelope for a failed request. Status code 500. Applicable to 1 of 30 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 30 methods.*
GetAvailableModelsByTypeInternalServerError: An unexpected error occurred on the server. Status code 500. Applicable to 1 of 30 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.user_account.init_auth(request={
        "email": "user@example.com",
    })

    # 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.user_account.init_auth(request={
        "email": "user@example.com",
    })

    # 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()))

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.

Project details

Release history Release notifications | RSS feed

1.2.0

Jun 3, 2026

This version

1.1.0

May 15, 2026

1.0.1

Mar 3, 2026

1.0.0

Mar 3, 2026

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pipeshub_sdk-1.1.0.tar.gz (152.7 kB view details)

Uploaded May 15, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

pipeshub_sdk-1.1.0-py3-none-any.whl (228.6 kB view details)

Uploaded May 15, 2026 Python 3

File details

Details for the file pipeshub_sdk-1.1.0.tar.gz.

File metadata

Download URL: pipeshub_sdk-1.1.0.tar.gz
Upload date: May 15, 2026
Size: 152.7 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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}

File hashes

Hashes for pipeshub_sdk-1.1.0.tar.gz
Algorithm	Hash digest
SHA256	`d24ee4ac1120f69763f91d0ebebb653ce827fc4bb0625aa95dfdc5ea954fbfa0`
MD5	`bbbc540268b084f8e5697972a84c0683`
BLAKE2b-256	`9f19f95f2ffa9c0931b3a79bb7d6e70bb05861168604860f306858d8f200f122`

See more details on using hashes here.

File details

Details for the file pipeshub_sdk-1.1.0-py3-none-any.whl.

File metadata

Download URL: pipeshub_sdk-1.1.0-py3-none-any.whl
Upload date: May 15, 2026
Size: 228.6 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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}

File hashes

Hashes for pipeshub_sdk-1.1.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`b1427d979056637ecde07b105861765007f1054c7a9381964fa8d6813ee21051`
MD5	`3f5af64fc5b37659d2779a645837db0e`
BLAKE2b-256	`ff06cc3e7807b879d09097b1c3dd177d77257abd3d66695b4e9ec575a7948bfc`

See more details on using hashes here.

pipeshub-sdk 1.1.0

Navigation

Verified details

Maintainers

Unverified details

Meta

Project description

pipeshub-sdk

Summary

Authentication

Base URLs

Table of Contents

SDK Installation

uv

PIP

Poetry

Shell and script usage with uv

IDE Support

PyCharm

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Per-Operation Security Schemes

Available Resources and Operations

AIModelsProviders

Conversations

KnowledgeHub

OrganizationAuthConfig

Organizations

SemanticSearch

UserAccount

Server-sent event streaming

Retries

Error Handling

Example

Error Classes

Server Selection

Select Server by Index

Example

Override Server URL Per-Client

Custom HTTP Client

Resource Management

Debugging

Project details

Verified details

Maintainers

Unverified details

Meta

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes

Shell and script usage with `uv`