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 application's token identity — the service account it is pointed at (tokenIdentityUserId), or its creator for an application registered before that was required and never bound, and sets the authenticated user accordingly. It reads the application record on every request, and a token minted for a different identity than the app's current one is refused with 401. See the OAuth Provider tag for full behavior.
Behaviour common to every route
App-level middleware runs before any router, so the following applies to every operation below, before authentication, unless an exception is named.
Markup filter. A query value, or any string in a JSON or form-encoded body, that looks like markup is refused with 400 HTTP_BAD_REQUEST. The message names where the value was, for example HTML tags, scripts, and XSS content are not allowed in the field "name". or ... in the query parameter "search". (a field name that is not a plain identifier path reads the request), and says what counted: text in angle brackets such as <id> counts as an HTML tag, an encoded script tag counts, or script content such as onclick=, javascript: or data:text/html counts. A string over 100,000 characters is refused as too long to check instead: The value of the field "name" is longer than 100,000 characters, which is too long to check for HTML tags and scripts. Please shorten it and try again. It looks for an HTML tag, a script tag, <iframe, <object, <embed or <svg tag, a word starting with on followed by = (meant for inline event handlers such as onerror=, it also catches plain text such as one=1), a javascript: or data:text/html URL, an encoded script tag (<script, %3cscript), and any string longer than 100,000 characters. A string the filter lets through is rewritten before the route sees it: the filter trims surrounding whitespace, drops a lone < together with everything after it (a < b arrives as a), and escapes > as >. POST and PUT under /agents/, /conversations/, /connectors and /api-toolsets, and POST, PUT and PATCH under /skills, skip the filter. So does the question of a search: the query string of a JSON body sent to POST /search or POST /retrieve is neither checked nor rewritten, unless it is longer than 100,000 characters.
Body parsers. application/json bodies (up to 10 MB, 5 MB on /mcp) and application/x-www-form-urlencoded bodies (up to 100 KB and 1000 fields) are parsed for every method. A JSON body that does not parse, or a body shorter or longer than its Content-Length, is answered 400 HTTP_BAD_REQUEST (The request body is not valid JSON., The request body does not match its Content-Length.), a body past these limits 413 HTTP_PAYLOAD_TOO_LARGE, and an unsupported content encoding or character set 415 HTTP_UNSUPPORTED_MEDIA_TYPE; a JSON body over 5 MB on /mcp gets its 413 as a JSON-RPC error (see POST /mcp). Form values arrive as text and the request validators do not convert them, so a number, a boolean or a free-form object sent form-encoded is refused (400 VALIDATION_ERROR) or read as a string. A list sent form-encoded is read as a list only when its key repeats, so a single value or an empty list cannot be sent. The form media type is therefore listed only on operations whose body is a flat object of text fields: every value a string (string enums included), with no lists or nested objects.
Request size. On every route with a request validator, the body, query and path values are measured before the schema runs. An array over 10,000 items (<path> can have at most 10000 items.), an object over 10,000 keys (<path> can have at most 10000 fields.), more than 100,000 array items and object keys in the whole request (The request holds too many items in total (the limit is 100000); the limit is reached at <path>.) or nesting deeper than 64 levels (<path> is nested more than 64 levels deep.) is refused with 400 VALIDATION_ERROR (detail code TOO_BIG, or TOO_DEEP for nesting; the path reads like body.items). The deployment can change the first three limits with VALIDATION_MAX_ARRAY_LENGTH, VALIDATION_MAX_OBJECT_KEYS and VALIDATION_MAX_TOTAL_ITEMS.
OAuth scopes. On an operation whose security names oauth2 scopes, an OAuth access token holding none of them gets 403 HTTP_FORBIDDEN ("Insufficient scope. Required: ...") right after authentication. Session tokens are never scope-checked.
No such route. A method and path that no route handles get Express's own 404 page, text/html, reading Cannot <METHOD> <path>. Such pairs are not listed as operations.
Base URLs
All endpoints use the /api/v1 prefix unless otherwise noted.
Query parameter names
On every /api/v1 and /mcp endpoint, a query parameter whose name starts with $ or contains . (including a nested name such as filter[$ne] or a.b) is refused with 400 and error code VALIDATION_ERROR. Only names are checked: values may contain dots, such as file names.
Table of Contents
- pipeshub-sdk
- Authentication
- Behaviour common to every route
- Base URLs
- Query parameter names
- SDK Installation
- IDE Support
- SDK Example Usage
- Retrieval for RAG and agent frameworks
- Authentication
- Available Resources and Operations
- Server-sent event streaming
- File uploads
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Resource Management
- Debugging
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())
Retrieval for RAG and agent frameworks
semantic_search.retrieve returns permission-filtered passages ("chunks"), each with its record and a citation link. It stores no search history, so you can call it on every request your application serves. See the Retrieval API docs.
Ready-made retrievers ship as extras:
pip install "pipeshub-sdk[langchain]" # pipeshub_sdk.integrations.langchain.PipesHubRetriever
pip install "pipeshub-sdk[llamaindex]" # pipeshub_sdk.integrations.llamaindex.PipesHubRetriever
from pipeshub_sdk import Pipeshub, models
from pipeshub_sdk.integrations.langchain import PipesHubRetriever
with Pipeshub(server_url="https://your-pipeshub-instance.com/api/v1",
security=models.Security(bearer_auth="phpat_...")) as client:
docs = PipesHubRetriever(client=client, limit=5).invoke("How do we roll back a canary deploy?")
Each result carries the chunk text and, in its metadata, the record (recordId, name, connector, mimeType, updatedAt), the citation (url, recordUrl, pageNum, blockIndex) and score. Both retrievers take limit, filters, max_chunks_per_record and rewrite_query, and support async. Examples: examples/retrievers/.
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
- list_agents - List agents
- create_agent - Create agent
- get_agent - Get agent
- update_agent - Update agent
- delete_agent - Delete agent
- list_agent_archived_conversations_grouped - List archived agent conversations grouped by agent
- list_agent_conversation_archives - List archived conversations for an agent
- upload_agent_conversation_chat_attachments - Upload agent chat attachments
- delete_agent_conversation_chat_attachment - Delete an agent chat attachment
- stream_agent_conversation - Create agent conversation with streaming response
- stream_agent_conversation_message - Add message to agent conversation with streaming response
- regenerate_agent_conversation_message - Regenerate agent conversation message
- fork_agent_conversation - Fork agent conversation from a message
- cancel_agent_conversation_stream - Cancel an in-flight agent chat stream
- update_agent_conversation_message_feedback - Submit feedback for an agent message
- add_agent_conversation_message - Add message to agent conversation (non-streaming)
- archive_agent_conversation - Archive an agent conversation
- unarchive_agent_conversation - Unarchive an agent conversation
- update_agent_conversation_title - Update agent conversation title
- delete_agent_conversation_by_id - Delete an agent conversation
- get_agent_conversation_by_id - Get agent conversation by ID
- list_agent_conversations - List agent conversations
- create_agent_conversation - Create agent conversation (non-streaming)
AIModelsProviders
- get_available_models_by_type - Get available models by type
Connector
- get_record_content - Get a record's full parsed content and metadata
- navigate_knowledge_graph - Browse the knowledge graph from a node
- lookup_record_by_identifier - Resolve a URL, issue key or external ID to a Record ID
ConnectorConfiguration
- get_connector_config - Get connector configuration
- update_connector_config - Update connector configuration
- update_connector_auth_config - Update authentication configuration
- update_connector_filters_sync_config - Update filters and sync configuration
ConnectorControl
- toggle_connector - Toggle connector sync or agent
ConnectorFilters
- get_connector_filters - Get filter options
save_connector_filters- Save filter selections (deprecated) ⚠️ Deprecated- get_filter_field_options - Get dynamic filter options
ConnectorInstances
- list_connector_instances - List connector instances
- create_connector_instance - Create connector instance
- get_connector_instance - Get connector instance
- delete_connector_instance - Delete connector instance
- get_connector_stats - Get connector statistics
- resync_connector - Resync connector
- stop_connector_sync - Stop the running sync for a connector
ConnectorOAuth
- get_o_auth_authorization_url - Get OAuth authorization URL
- handle_o_auth_callback - OAuth callback handler
ConnectorRegistry
- get_connector_registry - List available connector types
- get_connector_schema - Get connector configuration schema
- test_connector_connection - Test connector credentials before saving
- get_connector_egress_ips - Get the IP addresses connectors connect from
Conversations
- create_conversation - Create conversation (non-streaming)
- 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 - Add message (non-streaming)
- 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
- pin_conversation - Pin conversation
- unpin_conversation - Unpin conversation
- regenerate_answer - Regenerate AI response
- fork_conversation - Fork conversation from a message
- cancel_conversation_stream - Cancel an in-flight chat stream
- update_message_feedback - Submit feedback on AI response
KnowledgeBase
- create_knowledge_base - Create a new knowledge base
- list_knowledge_bases - List all knowledge bases
- get_knowledge_base - Get knowledge base by ID
- update_knowledge_base - Update knowledge base
- delete_knowledge_base - Delete knowledge base
- get_record_by_id - Get record by ID
- update_record_multipart - Update record
- update_record - Update record
- update_record_form - Update record
- delete_record - Delete record
- restore_record - Restore a deleted record
- restore_records - Restore several deleted records
- list_trash - List a collection's recently deleted items
- stream_record_buffer - Stream record content
- create_folder - Create folder
- create_subfolder - Create subfolder
- update_folder - Update folder
- delete_folder - Delete folder
- upload_records - Upload files to knowledge base or folder
- get_upload_limits - Get knowledge base upload limits
- reindex_record - Reindex single record
- reindex_record_group - Reindex record group
- move_record - Move record to another location
get_knowledge_hub_root_nodes- Get knowledge hub root nodes ⚠️ Deprecatedget_knowledge_hub_child_nodes- Get knowledge hub child nodes ⚠️ Deprecated
KnowledgeHub
get_knowledge_hub_root_nodes- Get knowledge hub root nodes ⚠️ Deprecatedget_knowledge_hub_child_nodes- Get knowledge hub child nodes ⚠️ Deprecated
OAuthApps
- list_o_auth_apps - List OAuth apps
- create_o_auth_app - Create OAuth app
- list_o_auth_scopes - List available scopes
- get_o_auth_app - Get OAuth app details
- update_o_auth_app - Update OAuth app
- delete_o_auth_app - Delete OAuth app
- regenerate_o_auth_app_secret - Regenerate client secret
- suspend_o_auth_app - Suspend OAuth app
- activate_o_auth_app - Activate suspended OAuth app
- list_o_auth_app_tokens - List app tokens
- revoke_all_o_auth_app_tokens - Revoke all app tokens
OAuthConfiguration
- get_o_auth_registry - List OAuth-capable connector types
- get_o_auth_connector_type - Get OAuth connector type details
- list_o_auth_configs - List OAuth configurations
- list_o_auth_configs_by_type - List OAuth configs for connector type
- create_o_auth_config - Create OAuth configuration
- get_o_auth_config - Get OAuth configuration
- update_o_auth_config - Update OAuth configuration
- delete_o_auth_config - Delete OAuth configuration
OAuthProvider
- oauth_token - Exchange authorization code for tokens
- oauth_revoke - Revoke an access or refresh token
- oauth_introspect - Introspect a token
OpenIDConnect
- oauth_user_info - Get authenticated user information
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
PersonalAccessTokens
- list_personal_access_tokens - List your own personal access tokens
- create_personal_access_token - Create a personal access token
- list_personal_access_token_scopes - List scopes available for a new personal access token
- revoke_personal_access_token - Revoke one of your own personal access tokens
- admin_list_personal_access_tokens - Admin: list every active personal access token in the org
- admin_revoke_personal_access_token - Admin: revoke any user's personal access token by id
SemanticSearch
- retrieve - Retrieve chunks with citations
- 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
- refresh_token - Refresh access token
- get_password_status - Get password status
- send_password_setup_email - Email a link to set a first password
- reset_password - Reset password
WebSearch
- get_web_search_providers - Get all web search providers
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.0,
},
], 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_multipart(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 errors:
PipeshubError: The base class for HTTP error responses.ErrorResponse: Standard error envelope returned by all errors routed throughErrorMiddleware. Applies to allBaseErrorsubclasses includingHttpError,ValidationError, and others. Thecodefield is a machine-readable string identifying the error type (e.g.HTTP_UNAUTHORIZED,HTTP_NOT_FOUND,VALIDATION_ERROR,INTERNAL_ERROR). *
Less common errors (21)
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:
OAuthClientManagementRateLimitError: JSON body when OAuth client management routes exceed the per-minute rate limit (same limiter as other/oauth-clients/*routes). Status code429. Applicable to 20 of 141 methods.*ApplicationJSONErrorResponse: Standard JSON error envelope fromErrorMiddlewareforBaseErrorsubclasses (error.middleware.ts). Returned for most API 4xx errors (unauthorized, forbidden, not found, validation failures, etc.). Applicable to 17 of 141 methods.*OAuthErrorResponse: OAuth 2.0 Error Response (RFC 6749 Section 5.2). Standard error format for OAuth endpoints. Applicable to 3 of 141 methods.*RateLimitErrorResponse: Rate-limit error payload (shape differs from standard error responses). Status code429. Applicable to 3 of 141 methods.*LocalFsDesktopRefusalError: 409 body returned when a Local FS connector cannot sync because of its owner device. Status code409. Applicable to 2 of 141 methods.*BadRequestError: Error envelope for a failed request. Status code400. Applicable to 1 of 141 methods.*UnauthorizedError: Error envelope for a failed request. Status code401. Applicable to 1 of 141 methods.*OAuthBearerTokenError: Error body written by the OAuth bearer-token middleware (RFC 6750 Section 3.1) on routes that accept only an OAuth access token, such asGET /oauth2/userinfo. The sameerror,error_descriptionandscopevalues are repeated in theWWW-Authenticateresponse header. This is not the standardErrorResponseenvelope:erroris a string. Applicable to 1 of 141 methods.*ForbiddenError: Error envelope for a failed request. Status code403. Applicable to 1 of 141 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 141 methods.*GetKnowledgeHubRootNodesUnprocessableEntityError: Either of: - A typed query parameter could not be read:pageorlimitis not an integer or is out of range (pagebelow 1,limitoutside 1-200),onlyContainersorflattenedis not a boolean, orpage/limitwas sent more than once.error.messageis the connector service's own validation text. - A listing that spans a whole connector (a flattened listing, a search or a filter) was too large for the database to hold in memory, so it was refused instead of cut short. No page is returned. Open a folder (GET /knowledgeBase/knowledge-hub/nodes/{parentType}/{parentId}) to see its records, or add a search (q), which keeps only matching records in memory. Choosing a connector, or a filter that keeps most records (such asnodeTypes), does not help. Sorting by name with no filters is served from stored visibility where the connector allows it and is not affected. Status code422. Applicable to 1 of 141 methods.*GetKnowledgeHubChildNodesUnprocessableEntityError: Either of: - A typed query parameter could not be read:pageorlimitis not an integer or is out of range (pagebelow 1,limitoutside 1-200), oronlyContainersorflattenedis not a boolean.error.messageis the connector service's own validation text. - A listing that spans a whole connector (a flattened listing, a search or a filter) was too large for the database to hold in memory, so it was refused instead of cut short. No page is returned. Open a folder (GET /knowledgeBase/knowledge-hub/nodes/{parentType}/{parentId}) to see its records, or add a search (q), which keeps only matching records in memory. Choosing a connector, or a filter that keeps most records (such asnodeTypes), does not help. Sorting by name with no filters is served from stored visibility where the connector allows it and is not affected. Status code422. Applicable to 1 of 141 methods.*UploadAgentConversationChatAttachmentsUnprocessableEntityError: A PDF that could not be read within the upload's 50-second budget, or whose parse ran out of memory, is not attached (<name> is too large or complex to read right now, so it wasn't attached. ...). Only that upload fails. Status code422. Applicable to 1 of 141 methods.*SearchHistoryInternalServerError: Error envelope for a failed request. Status code500. Applicable to 1 of 141 methods.*GetKnowledgeHubRootNodesServiceUnavailableError: The database could not give this listing the memory it needs right now, because other requests were using it (nothing is wrong with the request). Retry afterRetry-Afterseconds; the web app retries by itself. The body is the gateway's own busy message, not the service's wording. Status code503. Applicable to 1 of 141 methods.*GetKnowledgeHubChildNodesServiceUnavailableError: The database could not give this listing the memory it needs right now, because other requests were using it (nothing is wrong with the request). Retry afterRetry-Afterseconds; the web app retries by itself. The body is the gateway's own busy message, not the service's wording. Status code503. Applicable to 1 of 141 methods.*ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via thecauseattribute.
* 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 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pipeshub_sdk-2.0.0.tar.gz | 517.2 kB | Without provenance | Details for pipeshub_sdk-2.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pipeshub_sdk-2.0.0-py3-none-any.whl | Python 3 | none | any | Details for pipeshub_sdk-2.0.0-py3-none-any.whl |
Total release size: 1.3 MB
Release files / pipeshub_sdk-2.0.0.tar.gz
| Download URL | pipeshub_sdk-2.0.0.tar.gz |
|---|---|
| Size | 517.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fb7854845f9d1213e54e1c97ef27ef8e198cfc0edbb0d83c0e9a95e607417d1d
|
|
BLAKE2b-256 checksum How to use checksums |
b9d13d6312eb4b0b1dec53925decf45ba78c8f2dcac2e7b6b19bab6ab6276a77
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","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-2.0.0-py3-none-any.whl
| Download URL | pipeshub_sdk-2.0.0-py3-none-any.whl |
|---|---|
| Size | 810.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
54597ea2095c17f26f4565a1c6def2c8796e7b58e492266c5e342399a4307299
|
|
BLAKE2b-256 checksum How to use checksums |
bff17997dc82a806e9d91f53b35ebd952f9baab64d9438821c0d6d88f8e482fa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","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 2.0.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.