PipesHub is an open-source, enterprise-ready workplace AI platform positioned as an open-source alternative to Glean. It unifies scattered business data by connecting to business and enterprise apps, provides explainable, permission-aware enterprise search across them, and powers AI agents that get work done. It can be self-hosted from its public GitHub repository (pipeshub-ai/pipeshub-ai) or used as a hosted app, and documents a developer API reference for building on its enterprise context layer.
PipesHub publishes 51 API contracts indexed on the APIs.io network, including Agents API, AI Models Providers API, Authentication Configuration API, and 48 more. Tagged areas include Company, Artificial Intelligence, Enterprise Search, AI Agents, and Open Source.
The PipesHub catalog on APIs.io includes 1 event-driven AsyncAPI specification, 1 JSON-LD context, and 2 Spectral governance rulesets.
PipesHub’s developer surface includes changelog, sandbox, authentication, documentation, API reference, getting-started guide, engineering blog, and 49 more developer resources.
Regulatory Posture applies to this provider. Its tags matched the
Horizontal (data, software, accessibility, platform) regime, so
Regulatory Posture carries 15 points of the composite.
If this regime is wrong for your business, say so on your
provider repo — the
applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it
carries 10 points of the composite. It is scored from the published contracts
themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already
holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in
front of it, and the first time that check is skipped a duplicate record is created.
Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet,
not penalised by it.
The six quality facets above are damped to 75 points between them,
because the conditional facet above carries the other
25. That is why each facet's contribution is shown against a damped
maximum: raising a quality facet moves the composite by 75% of its nominal
weight, not 100%. The full arithmetic is at apis.io/rating/.
Show this score on your site.
It updates itself when the score changes. Paste this where you link to your API docs:
<a href="https://apis.io/providers/pipeshub/"><img src="https://apis.io/badge/pipeshub/card.svg" alt="PipesHub on APIs.io — Kin Score by API Evangelist"></a>
Other styles, a README pill and a shields.io endpoint are on the badge page.
Raise your score.
Agent readiness — checks not met, largest first (exact, from this profile):
Idempotency+9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented) Ask about this →
Protected Resource Metadata+5 pts — a served /.well-known/oauth-protected-resource carrying `resource` (documented), and naming its authorization_servers (verified) Ask about this →
Agentic Commerce Well-Known Document+5 pts — a parsing /.well-known/ucp.json or acp.json declaring a version and at least one service, OR (0.27) a live x402 payment challenge from _data/x402-adoption.json — `self` when its endpoints are on the provider's own domain, `platform` when they are on a vendor's Ask about this →
Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.
Not sure how this applies to your stack? Ask about any one item. Kin Lane reads every question, looks at your profile and your situation, and replies with what a fix would take — scoped to that one area, priced up front, yours whether you ship it or not. Ask a question →
The Kin Score Market layer reads a provider inside its market:
its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted:
not part of the Kin Score or agent readiness.
Registered MCP server and declares compatibility are report only — not weighted.
Undeclared means we found nothing we can read, so there is no number: we never infer integrations.
Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.
Server-backed Speech-to-Text (STT) and Text-to-Speech (TTS) for the chat UI. These endpoints are used by the chat frontend when an admin has configured a TTS/STT provider under ...
Endpoints for scheduling, managing, and monitoring data crawling jobs for enterprise connectors. The Crawling Manager uses BullMQ (Redis-based queue) to schedule and execute cra...
Service-to-service storage endpoints, authenticated with the storage scoped token rather than a signed-in user's session, so these are **not** callable by API clients or the bro...
Model Context Protocol (MCP) endpoints for AI tool integration. PipesHub exposes a Streamable HTTP MCP server that allows MCP-compatible clients (such as Claude Desktop, Cursor,...
Configure telemetry and metrics collection for application monitoring and analytics. PipesHub collects anonymized usage metrics to help improve the product. Metrics are pushed t...
Manage OAuth 2.0 client applications registered with PipesHub. OAuth apps allow third-party applications to access PipesHub APIs on behalf of users or organizations. Each app re...
PipesHub OAuth 2.0 Authorization Server implementing RFC 6749, RFC 7636 (PKCE), and OpenID Connect. **Supported Grant Types:** - `authorization_code` - Standard OAuth flow with ...
Self-service, long-lived, scoped, revocable credentials that act as their creator — unlike an OAuth app's `client_credentials` flow, which acts as the app. **Who can create one*...
Workspaces that group related assistant and agent conversations under a shared name, custom instructions, a knowledge scope, and reference files. Projects can be shared with tea...
Machine identities that automation authenticates as, so a script reads with its own permissions rather than borrowing a person's. A service account is an ordinary user record wi...
The credential a service account authenticates with. A service token is an OAuth access token, so signing, hashing, revocation and the `/mcp` path are the same machinery persona...
Beta: Skills (SKILL.md packages) that agents load on demand — CRUD, versioning, resources, import (npm/URL/upload), and learning-loop candidate review. Gated by the ENABLE_SKILL...
PipesHub exposes a remote MCP endpoint over Streamable HTTP at {PIPESHUB_INSTANCE_URL}/mcp ("no local npm packages or stdio processes needed"), plus an optional local stdio brid...
Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.
aid: pipeshub
name: PipesHub
description: PipesHub is an open-source, enterprise-ready workplace AI platform positioned as an open-source alternative to
Glean. It unifies scattered business data by connecting to business and enterprise apps, provides explainable, permission-aware
enterprise search across them, and powers AI agents that get work done. It can be self-hosted from its public GitHub repository
(pipeshub-ai/pipeshub-ai) or used as a hosted app, and documents a developer API reference for building on its enterprise
context layer.
url: https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/apis.yml
x-type: company
x-source: harvest:spectral-ruleset-github
x-tier: profiled
x-tier-reason: enrichment pass 2026-10-09 (modular-v1; was harvest)
accessModel:
pricing: freemium
onboarding: self-serve
trial: false
try_now: true
public: false
gated: none
gated_source:
- onboarding
label: Freemium · Self-serve signup
confidence: high
source:
- plans
- authentication
- scopes
- security
- sandbox
generated: '2026-11-13'
method: derived
specificationVersion: '0.20'
created: '2026-10-09'
modified: '2026-10-09'
tags:
- Company
- Artificial Intelligence
- Enterprise Search
- AI Agents
- Open Source
- Knowledge Management
- Workplace AI
maintainers:
- FN: Kin Lane
email: kin@apievangelist.com
- FN: APIs.json
email: info@apis.io
image: https://framerusercontent.com/images/87N6FTaGQx1IeB0Klbo9hPHAOus.png
common:
- type: FinOps
url: finops/pipeshub-finops.yml
- type: IntegrationEdges
url: integrations/pipeshub-integration-edges.yml
- type: CapabilityMap
url: capabilities/pipeshub-capability-edges.yml
name: PipesHub Business Capability Map
- type: AgenticAccess
url: agentic-access/pipeshub-agentic-access.yml
- type: RateLimits
url: rate-limits/pipeshub-rate-limits.yml
- type: Plans
url: plans/pipeshub-plans-pricing.yml
- type: Spectral
url: rules/pipeshub-rules.yml
- type: Spectral
url: rules/pipeshub-pipeshub-ai-spectral-rules.yml
- type: JSONLD
url: json-ld/pipeshub-context.jsonld
- type: Vocabulary
url: vocabulary/pipeshub-vocabulary.yml
- type: AgentSkill
url: skills/_index.yml
- type: Webhooks
url: asyncapi/pipeshub-webhooks.yml
- type: DataModel
url: data-model/pipeshub-data-model.yml
- type: ChangeLog
url: changelog/pipeshub-changelog.yml
- type: Conventions
url: conventions/pipeshub-conventions.yml
- type: Sandbox
url: sandbox/pipeshub-sandbox.yml
- type: Deprecation
url: lifecycle/pipeshub-lifecycle.yml
- type: Lifecycle
url: lifecycle/pipeshub-lifecycle.yml
- type: ErrorCatalog
url: errors/pipeshub-problem-types.yml
- type: Conformance
url: conformance/pipeshub-conformance.yml
- type: Overlay
url: overlays/pipeshub-openapi-overlay.yaml
- type: LLMsTxt
url: llms/pipeshub-llms.txt
- type: AgentCard
url: a2a/pipeshub-a2a.yml
- type: ToolCrosswalk
url: mcp/pipeshub-tool-crosswalk.yml
- type: MCPServer
url: mcp/pipeshub-mcp.yml
- type: WellKnown
url: well-known/pipeshub-well-known.yml
- type: Hosts
url: hosts/pipeshub-hosts.yml
- type: Vendors
url: vendors/pipeshub-vendors.yml
- type: SDKs
url: packages/pipeshub-packages.yml
- type: Packages
url: packages/pipeshub-packages.yml
- type: OAuthScopes
url: scopes/pipeshub-scopes.yml
- type: Authentication
url: authentication/pipeshub-authentication.yml
- type: DomainSecurity
url: security/pipeshub-domain-security.yml
- type: Website
url: https://pipeshub.com/
- type: SpectralRules
url: https://github.com/pipeshub-ai/pipeshub-ai/blob/a883af6d0f5d31f57d07d88dfcb1e9c483343e38/.spectral.yaml
- type: Documentation
url: https://docs.pipeshub.com/introduction
- type: APIReference
url: https://docs.pipeshub.com/developer/api-reference
- type: GettingStarted
url: https://docs.pipeshub.com/quickstart
- type: ChangeLog
url: https://docs.pipeshub.com/additional-resources/changelog
- type: Blog
url: https://pipeshub.com/blog
- type: GitHubOrganization
url: https://github.com/pipeshub-ai
- type: Pricing
url: https://pipeshub.com/pricing
- type: Login
url: https://app.pipeshub.com/
- type: Sandbox
url: https://sandbox.pipeshub.com/
- type: Security
url: https://pipeshub.com/security
- type: TermsOfService
url: https://pipeshub.com/terms
- type: PrivacyPolicy
url: https://pipeshub.com/privacy-policy
- type: Support
url: https://discord.com/invite/K5RskzJBm2
- type: LinkedIn
url: https://www.linkedin.com/company/pipeshub
- type: X
url: https://x.com/PipesHub
- type: YouTube
url: https://www.youtube.com/@PipesHub-GenAI
- type: UsageTerms
url: terms/pipeshub-terms-of-service.yml
- type: DataProcessing
url: privacy/pipeshub-privacy-policy.yml
- type: Eligibility
url: eligibility/pipeshub-eligibility.yml
- type: AIPreferences
url: ai-preferences/pipeshub-ai-preferences.yml
- type: DataLicense
url: data-license/pipeshub-data-license.yml
apis:
- aid: pipeshub:pipeshub-agents-api
name: PipesHub Agents API
description: Custom AI agents with specialized capabilities and tool integrations
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Agents
properties:
- type: OpenAPI
url: openapi/pipeshub-agents-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-agent-create-conversation-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-conversation-schema.json
- aid: pipeshub:pipeshub-ai-models-providers-api
name: PipesHub AI Models Providers API
description: Manage individual AI model providers - add, update, delete, and set defaults.
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- AI Models Providers
properties:
- type: OpenAPI
url: openapi/pipeshub-ai-models-providers-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-embedding-download-progress-payload-schema.json
- type: JSONSchema
url: json-schema/pipeshub-add-aimodel-provider-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-aimodel-field-schema-schema.json
- type: JSONSchema
url: json-schema/pipeshub-update-aimodel-provider-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-get-models-by-type-response-schema.json
- type: JSONSchema
url: json-schema/pipeshub-prepare-embedding-model-request-schema.json
- aid: pipeshub:pipeshub-authentication-configuration-api
name: PipesHub Authentication Configuration API
description: Configure authentication providers including Azure AD, Microsoft, Google OAuth, SAML SSO, and custom OAuth
2.0.
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Authentication Configuration
properties:
- type: OpenAPI
url: openapi/pipeshub-authentication-configuration-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-generic-oauth-config-schema.json
- type: JSONSchema
url: json-schema/pipeshub-ssoauth-config-schema.json
- type: JSONSchema
url: json-schema/pipeshub-azure-ad-auth-config-schema.json
- type: JSONSchema
url: json-schema/pipeshub-microsoft-auth-config-schema.json
- type: JSONSchema
url: json-schema/pipeshub-google-auth-config-schema.json
- aid: pipeshub:pipeshub-configuration-manager-api
name: PipesHub Configuration Manager API
description: Manage organization-level configuration including Slack bot integration, AI models, and metrics collection.
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Configuration Manager
properties:
- type: OpenAPI
url: openapi/pipeshub-configuration-manager-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-get-aimodels-providers-response-schema.json
- type: JSONSchema
url: json-schema/pipeshub-update-model-roles-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-update-model-roles-response-schema.json
- type: JSONSchema
url: json-schema/pipeshub-get-model-roles-response-schema.json
- aid: pipeshub:pipeshub-connector-api
name: PipesHub Connector API
description: Connector-related operations
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Connector
properties:
- type: OpenAPI
url: openapi/pipeshub-connector-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-navigate-knowledge-graph-response-schema-schema.json
- type: JSONSchema
url: json-schema/pipeshub-lookup-record-response-schema-schema.json
- type: JSONSchema
url: json-schema/pipeshub-get-record-content-response-schema-schema.json
- aid: pipeshub:pipeshub-connector-configuration-api
name: PipesHub Connector Configuration API
description: Configure authentication, sync settings, and filters for connectors
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Connector Configuration
properties:
- type: OpenAPI
url: openapi/pipeshub-connector-configuration-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-connector-config-schema.json
- type: JSONSchema
url: json-schema/pipeshub-update-connector-config-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-update-connector-auth-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-update-connector-filters-sync-request-schema.json
- aid: pipeshub:pipeshub-connector-control-api
name: PipesHub Connector Control API
description: Enable/disable connectors for sync or agent functionality
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Connector Control
properties:
- type: OpenAPI
url: openapi/pipeshub-connector-control-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-connector-instance-schema.json
- type: JSONSchema
url: json-schema/pipeshub-connector-toggle-request-schema.json
- aid: pipeshub:pipeshub-connector-filters-api
name: PipesHub Connector Filters API
description: Dynamic filter options for selecting which data to sync
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Connector Filters
properties:
- type: OpenAPI
url: openapi/pipeshub-connector-filters-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-filter-options-schema.json
- type: JSONSchema
url: json-schema/pipeshub-save-connector-filters-request-schema.json
- aid: pipeshub:pipeshub-connector-instances-api
name: PipesHub Connector Instances API
description: Create, manage, and delete connector instances for your organization
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Connector Instances
properties:
- type: OpenAPI
url: openapi/pipeshub-connector-instances-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-connector-instance-schema.json
- type: JSONSchema
url: json-schema/pipeshub-create-connector-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-connector-stats-schema.json
- type: JSONSchema
url: json-schema/pipeshub-connector-pagination-schema.json
- type: JSONSchema
url: json-schema/pipeshub-resync-connector-request-body-schema.json
- type: JSONSchema
url: json-schema/pipeshub-update-connector-name-request-schema.json
- aid: pipeshub:pipeshub-connector-oauth-api
name: PipesHub Connector OAuth API
description: OAuth 2.0 authorization flow for connectors requiring user consent
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Connector OAuth
properties:
- type: OpenAPI
url: openapi/pipeshub-connector-oauth-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- aid: pipeshub:pipeshub-connector-registry-api
name: PipesHub Connector Registry API
description: Browse available connector types and their configuration schemas
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Connector Registry
properties:
- type: OpenAPI
url: openapi/pipeshub-connector-registry-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-connector-type-schema.json
- type: JSONSchema
url: json-schema/pipeshub-connector-schema-schema.json
- type: JSONSchema
url: json-schema/pipeshub-connector-pagination-schema.json
- aid: pipeshub:pipeshub-connectors-api
name: PipesHub Connectors API
description: The Connectors API from PipesHub — 1 operation(s) for connectors.
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Connectors
properties:
- type: OpenAPI
url: openapi/pipeshub-connectors-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- aid: pipeshub:pipeshub-conversational-speech-api
name: PipesHub Conversational Speech API
description: 'Server-backed Speech-to-Text (STT) and Text-to-Speech (TTS) for the chat UI.
These endpoints are used by the chat frontend when an admin has configured a
TTS/STT provider under the AI Models configuration. When no provider is
configured the client falls back to the browser''s native Web Speech API, so
callers should treat a `409` response as "unconfigured, use browser APIs"
rather than as a fatal error.'
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Conversational Speech
properties:
- type: OpenAPI
url: openapi/pipeshub-conversational-speech-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-transcription-response-schema.json
- type: JSONSchema
url: json-schema/pipeshub-speak-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-speech-capabilities-response-schema.json
- aid: pipeshub:pipeshub-conversations-api
name: PipesHub Conversations API
description: AI-powered conversational chat management with citations and follow-up questions
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Conversations
properties:
- type: OpenAPI
url: openapi/pipeshub-conversations-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-conversation-schema.json
- type: JSONSchema
url: json-schema/pipeshub-create-conversation-request-schema.json
- aid: pipeshub:pipeshub-crawling-jobs-api
name: PipesHub Crawling Jobs API
description: 'Endpoints for scheduling, managing, and monitoring data crawling jobs for enterprise connectors.
The Crawling Manager uses BullMQ (Redis-based queue) to schedule and execute crawling jobs that
sync data from external connectors (Google Drive, OneDrive, Slack, Jira, etc.) into PipesHub''s
search index.
**Key Features:**
- Schedule recurring crawls (hourly, daily, weekly, monthly) or one-time crawls
- Pause and resume crawling jobs without losing configuration
- Priority-based job execution (1-10 scale)
- Automatic retry with exponential backoff on failures
- Per-connector job isolation and tracking
**Access Control:**
- Team-scoped connectors require admin privileges
- Personal-scoped connectors can only be managed by the creator
- All operations require valid JWT authentication
**Schedule Types:**
- `hourly`: Run every X hours at specified minute
- `daily`: Run once per day at specified time
- `weekly`: Run on specified days of the week
- `monthly`: Run on specified day of the month
- `custom`: Use cron expression for complex schedules
- `once`: Run once at a specific future time'
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Crawling Jobs
properties:
- type: OpenAPI
url: openapi/pipeshub-crawling-jobs-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-job-status-schema.json
- type: JSONSchema
url: json-schema/pipeshub-schedule-config-schema.json
- aid: pipeshub:pipeshub-internal-storage-api
name: PipesHub Internal Storage API
description: 'Service-to-service storage endpoints, authenticated with the storage
scoped token rather than a signed-in user''s session, so these are **not**
callable by API clients or the browser. Storage checks only the org, not
record permissions; read and write files through the Knowledge Base
routes (for example `GET /knowledgeBase/stream/record/{recordId}`).'
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Internal Storage
properties:
- type: OpenAPI
url: openapi/pipeshub-internal-storage-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- aid: pipeshub:pipeshub-knowledge-base-api
name: PipesHub Knowledge Base API
description: Knowledge base management operations
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Knowledge Base
properties:
- type: OpenAPI
url: openapi/pipeshub-knowledge-base-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-get-record-by-id-response-schema-schema.json
- type: JSONSchema
url: json-schema/pipeshub-record-schema.json
- type: JSONSchema
url: json-schema/pipeshub-knowledge-hub-nodes-response-schema.json
- aid: pipeshub:pipeshub-knowledge-hub-api
name: PipesHub Knowledge Hub API
description: Unified browse API for root and child nodes (apps, record groups, folders, records) with filtering and search
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Knowledge Hub
properties:
- type: OpenAPI
url: openapi/pipeshub-knowledge-hub-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-knowledge-hub-nodes-response-schema.json
- aid: pipeshub:pipeshub-mcp-api
name: PipesHub MCP API
description: 'Model Context Protocol (MCP) endpoints for AI tool integration.
PipesHub exposes a Streamable HTTP MCP server that allows MCP-compatible clients
(such as Claude Desktop, Cursor, or custom agents) to interact with PipesHub tools
including search, conversations, knowledge base management, and connector operations.
**Transport:** Streamable HTTP (JSON-RPC over HTTP)
**Base Path:** `/mcp` (not under `/api/v1`)
**Authentication:**
All MCP requests require a valid Bearer token or OAuth 2.0 access token.
**Stateless Mode:**
The server operates in stateless mode — each request creates an independent MCP session.'
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- MCP
properties:
- type: OpenAPI
url: openapi/pipeshub-mcp-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- aid: pipeshub:pipeshub-metrics-collection-api
name: PipesHub Metrics Collection API
description: 'Configure telemetry and metrics collection for application monitoring and analytics.
PipesHub collects anonymized usage metrics to help improve the product. Metrics are pushed
to a configurable remote server at regular intervals.
**Collected Metrics:**
- API request counts and response times
- User activity patterns (anonymized)
- Feature usage statistics
- Error rates and types
**Configuration Options:**
- Enable/disable metrics collection entirely
- Configure push interval (minimum 1 second, default 60 seconds)
- Set custom metrics server URL for self-hosted analytics
**Privacy:**
- All metrics are anonymized before collection
- No personally identifiable information (PII) is collected
- Organization can disable collection at any time'
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Metrics Collection
properties:
- type: OpenAPI
url: openapi/pipeshub-metrics-collection-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-metrics-collection-config-schema.json
- aid: pipeshub:pipeshub-notifications-api
name: PipesHub Notifications API
description: In-app notifications for the signed-in user (connector errors, warnings, and related alerts)
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Notification
tags_raw:
- Notifications
properties:
- type: OpenAPI
url: openapi/pipeshub-notifications-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-in-app-notification-schema.json
- aid: pipeshub:pipeshub-oauth-api
name: PipesHub OAuth API
description: OAuth 2.0 token exchange for third-party authentication providers
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- OAuth
- Authentication
tags_raw:
- OAuth
- Authentication
properties:
- type: OpenAPI
url: openapi/pipeshub-oauth-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-oauth-exchange-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-oauth-exchange-response-schema.json
- aid: pipeshub:pipeshub-oauth-apps-api
name: PipesHub OAuth Apps API
description: 'Manage OAuth 2.0 client applications registered with PipesHub.
OAuth apps allow third-party applications to access PipesHub APIs on behalf of users
or organizations. Each app receives a client ID and secret for authentication.
**Who can see which apps**
- **Everyone (including org admins)** sees and manages only OAuth apps **they created** (`createdBy`). Other members''
apps are hidden (not listed; individual operations return not found).
**Session only**
- Every `/oauth-clients/*` route requires the user''s interactive session JWT. OAuth access tokens and personal access
tokens (`phpat_...`) are rejected with `403`, so a token issued to a client can never register, reconfigure, or revoke
clients on its own.
**Who authorizes vs. client credentials**
- **Authorization code:** Any authenticated user in the workspace may complete consent for a valid `client_id`; issued
tokens represent **that user**.
- **Client credentials:** Access tokens represent the **OAuth app creator** (who registered the client), not the caller.
**Scopes**
- `GET /oauth-clients/scopes` returns scopes grouped by category for the **signed-in user''s role**.
- **Org admins** may register apps that request additional **admin-only** scopes; non-admins cannot select those scopes
when creating or updating an app.
**App Types:**
- **Confidential clients**: Server-side apps that can securely store secrets
- **Public clients**: Browser/mobile apps that cannot securely store secrets (use PKCE)
**App Lifecycle:**
- Create apps with name, redirect URIs, allowed scopes, and optional URLs (homepage, privacy, terms)
- Regenerate secrets if compromised
- Suspend/activate apps to control access
- Revoke all tokens for emergency access removal'
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- OAuth Apps
properties:
- type: OpenAPI
url: openapi/pipeshub-oauth-apps-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-create-oauth-app-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-oauth-app-response-schema.json
- type: JSONSchema
url: json-schema/pipeshub-update-oauth-app-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-oauth-scopes-grouped-response-schema.json
- type: JSONSchema
url: json-schema/pipeshub-oauth-app-list-response-schema.json
- type: JSONSchema
url: json-schema/pipeshub-regenerate-oauth-app-secret-response-schema.json
- aid: pipeshub:pipeshub-oauth-configuration-api
name: PipesHub OAuth Configuration API
description: Admin management of OAuth credentials for connector types
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- OAuth Configuration
properties:
- type: OpenAPI
url: openapi/pipeshub-oauth-configuration-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-connector-type-schema.json
- type: JSONSchema
url: json-schema/pipeshub-create-oauth-config-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-oauth-config-schema.json
- type: JSONSchema
url: json-schema/pipeshub-connector-pagination-schema.json
- aid: pipeshub:pipeshub-oauth-provider-api
name: PipesHub OAuth Provider API
description: 'PipesHub OAuth 2.0 Authorization Server implementing RFC 6749, RFC 7636 (PKCE), and OpenID Connect.
**Supported Grant Types:**
- `authorization_code` - Standard OAuth flow with PKCE support
- `client_credentials` - Machine-to-machine authentication
- `refresh_token` - Token refresh for long-lived access
**Security Features:**
- PKCE (Proof Key for Code Exchange) for public clients
- State parameter for CSRF protection
- Configurable token lifetimes
- Token revocation and introspection
**OpenID Connect:**
- ID tokens with standard claims
- UserInfo endpoint for profile data
- Discovery endpoint for automatic configuration
**Machine tokens (`client_credentials`) — gateway and downstream identity:**
Access tokens may encode **`userId === client_id`**. The **Node.js API gateway** resolves the effective user to the OAuth
**app creator**: first using the JWT **`createdBy`** claim when present, otherwise by loading the OAuth app by **`client_id`**
from the registry. After verification it sets the authenticated session to that creator.
**Python services:** Validate `Authorization: Bearer` as today and use the JWT payload’s **`userId`** as-is for scopes
and user-scoped logic (which may still equal **`client_id`** for machine tokens).
**Operational note:** Prefer tokens whose JWT already carries the creator as **`userId`**; use **`POST /oauth-clients/{appId}/revoke-all-tokens`**
and obtain new tokens from **`POST /oauth2/token`** when rotating integrations.'
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- OAuth Provider
properties:
- type: OpenAPI
url: openapi/pipeshub-oauth-provider-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-oauth-token-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-oauth-consent-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-oauth-introspect-response-schema.json
- type: JSONSchema
url: json-schema/pipeshub-oauth-token-response-schema.json
- type: JSONSchema
url: json-schema/pipeshub-oauth-revoke-request-schema.json
- type: JSONSchema
url: json-schema/pipeshub-oauth-introspect-request-schema.json
- aid: pipeshub:pipeshub-openid-connect-api
name: PipesHub OpenID Connect API
description: 'OpenID Connect 1.0 endpoints for identity federation and discovery.
**Discovery:**
- `/.well-known/openid-configuration` - Authorization server metadata
- `/.well-known/oauth-authorization-server` - Authorization server metadata (RFC 8414)
- `/.well-known/oauth-protected-resource/mcp` - Protected resource metadata (RFC 9728)
- `/.well-known/jwks.json` - Public keys for token verification
**UserInfo:**
- `/oauth2/userinfo` - Get authenticated user''s profile information
**Supported Claims:**
- `user_id` - User identifier
- `email`, `email_verified` - Email information
- `name`, `given_name`, `family_name` - Name information'
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- OpenID Connect
properties:
- type: OpenAPI
url: openapi/pipeshub-openid-connect-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- type: JSONSchema
url: json-schema/pipeshub-open-idconfiguration-schema.json
- type: JSONSchema
url: json-schema/pipeshub-oauth-protected-resource-metadata-schema.json
- type: JSONSchema
url: json-schema/pipeshub-oauth-user-info-response-schema.json
- type: JSONSchema
url: json-schema/pipeshub-jwks-schema.json
- aid: pipeshub:pipeshub-organization-auth-config-api
name: PipesHub Organization Auth Config API
description: Admin configuration of authentication methods including MFA steps and allowed providers
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Organization Auth Config
properties:
- type: OpenAPI
url: openapi/pipeshub-organization-auth-config-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- aid: pipeshub:pipeshub-organizations-api
name: PipesHub Organizations API
description: Organization management operations
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Organization
tags_raw:
- Organizations
properties:
- type: OpenAPI
url: openapi/pipeshub-organizations-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
- aid: pipeshub:pipeshub-permissions-api
name: PipesHub Permissions API
description: Permission management for knowledge bases
humanURL: https://docs.pipeshub.com/developer/api-reference
baseURL: https://app.pipeshub.com/api/v1
tags:
- Permissions
properties:
- type: OpenAPI
url: openapi/pipeshub-permissions-api-openapi.yml
- type: Documentation
url: https://docs.pipeshub.com/developer/api-reference
# --- truncated at 32 KB (45 KB total) ---
# Full source: https://artifacts.apis.io/pipeshub/apis.yml
PipesHub API — frequently asked questions
Does PipesHub have an API?
Yes. APIs.io lists 51 APIs from PipesHub, including PipesHub Agents API, PipesHub AI Models Providers API and PipesHub Authentication Configuration API, and 48 more.
Is there an OpenAPI specification for the PipesHub API?
Yes. APIs.io indexes 51 OpenAPI specifications for PipesHub, each linked for download from this page.
How do I authenticate with the PipesHub API?
PipesHub documents its authentication (http/oauth2 · 2 schemes). The details are profiled on APIs.io as PipesHub Authentication.
How much does the PipesHub API cost?
PipesHub publishes its prices; its Community Edition plan is $0/Forever as of 2026-10-09. APIs.io lists 2 pricing plans for PipesHub, with each plan's price, limits and inclusions under Pricing on this page.
Does PipesHub have an MCP server?
Yes. APIs.io lists 1 MCP server for PipesHub: PipesHub exposes a remote MCP endpoint over Streamable HTTP at {PIPESHUB_INSTANCE_URL}/mcp ("no local npm packages or stdio processes needed"), plus an optional local stdio bridge published as the npm
Is the PipesHub API ready for AI agents?
PipesHub has a Kin Score of 67.6 out of 100 (exemplar) and an Agent Readiness score of 43.1 (agent-ready), scored by API Evangelist on 2026-11-13.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.