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.0.1

Published

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

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.

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.userAccount.initAuth({
    email: "[email protected]",
  });

  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.userAccount.initAuth({
    email: "[email protected]",
  });

  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.resetPasswordWithToken({
    scopedToken: "<YOUR_BEARER_TOKEN_HERE>",
  }, {
    password: "H9GEHoL829GXj06",
  });

  console.log(result);
}

run();

Available Resources and Operations

AgentConversations

AgentTemplates

Agents

AIModelsProviders

AuthenticationConfiguration

ConfigurationManager

Connector

ConnectorConfiguration

ConnectorControl

ConnectorFilters

ConnectorInstances

ConnectorOAuth

ConnectorRegistry

Conversations

CrawlingJobs

DocumentManagement

Folders

KnowledgeBases

MetricsCollection

OAuth

OAuthApps

OAuthConfiguration

OAuthProvider

OpenIDConnect

OrganizationAuthConfig

Organizations

Permissions

PlatformSettings

PublicURLs

Records

Saml

SemanticSearch

SMTPConfiguration

StorageConfiguration

Teams

ToolsetConfiguration

ToolsetInstances

ToolsetOAuth

ToolsetRegistry

Upload

UserAccount

UserGroups

Users

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.