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

@aashil/pipeshub

v0.1.1

Published

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

Vulnerabilities

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

Links

Maintainers

aashilaashil

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.

Base URLs

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

Table of Contents

SDK Installation

[!TIP] To finish publishing your SDK to npm and others you must run your first generation action.

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

NPM

npm add <UNSET>

PNPM

pnpm add <UNSET>

Bun

bun add <UNSET>

Yarn

yarn add <UNSET>

[!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";

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

async function run() {
  const result = await pipeshub.userAccount.initializeAuth({
    email: "[email protected]",
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | ------------ | ---- | ----------- | ---------------------- | | bearerAuth | http | HTTP Bearer | PIPESHUB_BEARER_AUTH |

To authenticate with the API the bearerAuth parameter must be set when initializing the SDK client instance. For example:

import { Pipeshub } from "pipeshub";

const pipeshub = new Pipeshub({
  serverURL: "https://api.example.com",
  bearerAuth: process.env["PIPESHUB_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await pipeshub.userAccount.initializeAuth({
    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";

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

async function run() {
  const result = await pipeshub.userAccount.resetPasswordWithToken({
    scopedToken: process.env["PIPESHUB_SCOPED_TOKEN"] ?? "",
  }, {
    password: "H9GEHoL829GXj06",
  });

  console.log(result);
}

run();

Available Resources and Operations

AgentConversations

  • list - List agent conversations
  • start - Create agent conversation
  • stream - Create agent conversation with streaming
  • get - Get agent conversation
  • delete - Delete agent conversation
  • addMessage - Add message to agent conversation
  • streamMessage - Add message with streaming
  • regenerate - Regenerate agent response

Agents

AgentTemplates

  • list - List agent templates
  • create - Create agent template
  • get - Get agent template
  • update - Update agent template
  • delete - Delete agent template

AiModelsConfiguration

  • create - Bulk create AI models configuration
  • getAll - Get all AI models configuration

AiModelsProviders

AuthConfig

AuthenticationConfiguration

AuthenticationConfigurations

Connector

ConnectorConfiguration

ConnectorConfigurations

ConnectorControl

  • toggle - Toggle connector sync or agent

ConnectorFilters

ConnectorInstances

ConnectorOAuth

ConnectorOauthConfiguration

ConnectorOAuthConfiguration

ConnectorOAuthConfigurations

ConnectorRegistry

  • list - List available connector types
  • getSchema - Get connector configuration schema

ConnectorService

ConnectorServices

Conversations

CrawlingJobs

  • schedule - Schedule a crawling job
  • getStatus - Get crawling job status
  • remove - Remove a crawling job
  • pause - Pause a crawling job
  • resume - Resume a paused crawling job
  • list - Get all crawling job statuses
  • removeAll - Remove all crawling jobs

DoclingService

  • healthCheck - [Docling Service] Health check
  • processPdf - [Docling Service] Process PDF document
  • parsePdf - [Docling Service] Parse PDF (Phase 1)
  • createBlocks - [Docling Service] Create blocks from parse result (Phase 2)

DocumentBuffer

  • get - Get document buffer
  • update - Update document buffer

DocumentManagement

DocumentUpload

EmailOperations

  • send - Send a transactional email

Folders

IndexingService

  • health - [Indexing Service] Health check

KnowledgeBases

MailConfiguration

MetricsCollection

MetricsCollections

  • toggle - Enable or disable metrics collection

Oauth

OauthApps

OauthConfiguration

OAuthConfiguration

  • create - Create OAuth configuration

OauthConfigurations

OauthProvider

OpenIDConnect

OrganizationAuthConfig

OrganizationAuthConfigs

  • create - Create organization authentication configuration

OrganizationAuthConfiguration

Organizations

Permissions

PlatformSettings

PublicUrls

QueryService

  • search - [Query Service] Semantic search
  • chat - [Query Service] Chat with knowledge base
  • chatStream - [Query Service] Streaming chat with knowledge base
  • healthCheck - [Query Service] AI model health check
  • listTools - [Query Service] List available agent tools

QueryServices

QueueManagement

Records

  • get - Get all records across knowledge bases
  • list - Get records for a knowledge base
  • getById - Get record by ID
  • update - Update record
  • delete - Delete record
  • streamContent - Stream record content
  • move - Move a record to another folder

Saml

SemanticSearch

SmtpConfiguration

StorageConfiguration

Teams

Upload

UserAccount

UserGroups

Users

VersionControl

Webhooks

  • verifyGmail - [Connector Service] Gmail webhook verification
  • postGmail - [Connector Service] Gmail webhook
  • handle - [Connector Service] Google Workspace Admin webhook

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][mdn-sse] 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][mdn-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";

const pipeshub = new Pipeshub({
  serverURL: "https://api.example.com",
  bearerAuth: process.env["PIPESHUB_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await pipeshub.conversations.stream({
    query: "What are the key findings from our Q4 financial report?",
    recordIds: [
      "507f1f77bcf86cd799439011",
      "507f1f77bcf86cd799439012",
    ],
    modelKey: "gpt-4-turbo",
    model