npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@pipeshub-ai/sdk

v1.2.0

Published

<!-- Start Summary [summary] --> ## Summary

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

aashilaashilrishabh_gupta2312rishabh_gupta2312

Keywords

Readme

pipeshub-sdk-typescript

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.

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @pipeshub-ai/sdk

PNPM

pnpm add @pipeshub-ai/sdk

Bun

bun add @pipeshub-ai/sdk

Yarn

yarn add @pipeshub-ai/sdk

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Pipeshub } from "@pipeshub-ai/sdk";

const pipeshub = new Pipeshub();

async function run() {
  const result = await pipeshub.oAuthProvider.oauthToken({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

| Name | Type | Scheme | | ------------ | ------ | ------------ | | bearerAuth | http | HTTP Bearer | | oauth2 | oauth2 | OAuth2 token |

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 { Pipeshub } from "@pipeshub-ai/sdk";

const pipeshub = new Pipeshub({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
  },
});

async function run() {
  const result = await pipeshub.oAuthProvider.oauthToken({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Per-Operation Security Schemes

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

import { Pipeshub } from "@pipeshub-ai/sdk";

const pipeshub = new Pipeshub();

async function run() {
  const result = await pipeshub.userAccount.refreshToken({
    scopedToken: "<YOUR_BEARER_TOKEN_HERE>",
  });

  console.log(result);
}

run();

Available Resources and Operations

Agents

AIModelsProviders

Conversations

KnowledgeHub

OAuthApps

OAuthProvider

OpenIDConnect

OrganizationAuthConfig

Organizations

SemanticSearch

UserAccount

WebSearch

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Server-sent event streaming

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

import { Pipeshub } from "@pipeshub-ai/sdk";

const pipeshub = new Pipeshub({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
  },
});

async function run() {
  const result = await pipeshub.conversations.streamChat({
    query: "What are the key findings from our Q4 financial report?",
    recordIds: [
      "507f1f77bcf86cd799439011",
      "507f1f77bcf86cd799439012",
    ],
    modelKey: "gpt-4-turbo",
    modelName: "GPT-4 Turbo",
    modelFriendlyName: "GPT-4 Turbo",
    chatMode: "web_search",
    timezone: "America/New_York",
    currentTime: new Date("2026-04-12T16:00:00+05:30"),
    tools: [
      "jira.create_issue",
      "confluence.search_content",
    ],
  });

  for await (const event of result) {
    console.log(event);
  }
}

run();

File uploads

Certain SDK methods accept files as part of a 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.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

  • Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
  • Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
  • Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
  • Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.
import { Pipeshub } from "@pipeshub-ai/sdk";

const pipeshub = new Pipeshub({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
  },
});

async function run() {
  const result = await pipeshub.agents.uploadAgentConversationChatAttachments({
    agentKey: "<value>",
    body: {
      files: [],
    },
  });

  console.log(result);
}

run();

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:

import { Pipeshub } from "@pipeshub-ai/sdk";

const pipeshub = new Pipeshub();

async function run() {
  const result = await pipeshub.oAuthProvider.oauthToken({
    grantType: "client_credentials",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Pipeshub } from "@pipeshub-ai/sdk";

const pipeshub = new Pipeshub({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await pipeshub.oAuthProvider.oauthToken({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Error Handling

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

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Pipeshub } from "@pipeshub-ai/sdk";
import * as errors from "@pipeshub-ai/sdk/models/errors";

const pipeshub = new Pipeshub();

async function run() {
  try {
    const result = await pipeshub.oAuthProvider.oauthToken({
      grantType: "client_credentials",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.PipeshubError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorResponse) {
        console.log(error.data$.error); // models.ErrorResponseError
      }
    }
  }
}

run();

Error Classes

Primary error:

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 20 of 65 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 14 of 65 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 11 of 65 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 65 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 65 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 65 methods.*
  • SearchHistoryBadRequestError: Error envelope for a failed request. Status code 400. Applicable to 1 of 65 methods.*
  • GetSearchByIdBadRequestError: Invalid request — searchId failed Zod validation (not a valid ObjectId). Status code 400. Applicable to 1 of 65 methods.*
  • DeleteAgentConversationChatAttachmentBadRequestError: Invalid or blank path params (agentKey or recordId). Status code 400. Applicable to 1 of 65 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 65 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 65 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 65 methods.*
  • SearchHistoryUnauthorizedError: Error envelope for a failed request. Status code 401. Applicable to 1 of 65 methods.*
  • GetSearchByIdUnauthorizedError: Missing or invalid bearer token. Status code 401. Applicable to 1 of 65 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 65 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 65 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 65 methods.*
  • SearchHistoryForbiddenError: Error envelope for a failed request. Status code 403. Applicable to 1 of 65 methods.*
  • GetSearchByIdForbiddenError: Bearer token lacks the semantic:read scope. Status code 403. Applicable to 1 of 65 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 65 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 65 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 65 methods.*
  • GetKnowledgeHubRootNodesInternalServerError: An unexpected error occurred on the server. Status code 500. Applicable to 1 of 65 methods.*
  • GetKnowledgeHubChildNodesInternalServerError: An unexpected error occurred on the server. Status code 500. Applicable to 1 of 65 methods.*
  • SearchHistoryInternalServerError: Error envelope for a failed request. Status code 500. Applicable to 1 of 65 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 65 methods.*
  • GetAvailableModelsByTypeInternalServerError: An unexpected error occurred on the server. Status code 500. Applicable to 1 of 65 methods.*
  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* 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 serverIdx: number 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 | instanceUrl: string | "https://app.pipeshub.com" | Base server URL |

Example

import { Pipeshub } from "@pipeshub-ai/sdk";

const pipeshub = new Pipeshub({
  serverIdx: 0,
  instanceUrl: "https://app.pipeshub.com",
});

async function run() {
  const result = await pipeshub.oAuthProvider.oauthToken({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Override Server URL Per-Client

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

import { Pipeshub } from "@pipeshub-ai/sdk";

const pipeshub = new Pipeshub({
  serverURL: "https://https://app.pipeshub.com",
});

async function run() {
  const result = await pipeshub.oAuthProvider.oauthToken({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { Pipeshub } from "@pipeshub-ai/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@pipeshub-ai/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Pipeshub({ httpClient: httpClient });

Debugging

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

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Pipeshub } from "@pipeshub-ai/sdk";

const sdk = new Pipeshub({ debugLogger: console });