.mint-mt-2 {
    margin-top: 0.5rem
}
.mint-flex {
    display: flex
}
.mint-flex-col {
    flex-direction: column
}
.mint-items-center {
    align-items: center
}
.mint-justify-center {
    justify-content: center
}
.mint-pt-10 {
    padding-top: 2.5rem
}
.mint-text-center {
    text-align: center
}
.mint-text-xl {
    font-size: 1.25rem;
    line-height: 1.75rem
}
.mint-font-bold {
    font-weight: 700
}

How to use swagger to refer APIs of the PipesHub Workplace AI platform

API References

PipesHub Workplace AI

Introduction

How to deploy PipesHub Workplace AI platform on your local machine

Quickstart

Preview changes locally to update your docs

Development

This guide walks through setting up the system when first time logging in, starting with AI model configuration, followed by optional configurations for storage, connectors, and SMTP.

Onboarding

Feel free to reach out anytime — We are always happy to help!

Contact Us

System Overview

Documentation for the Authentication Service

Authentication Service

Documentation for the User Management Service

User Management

Documentation for the Token Manager Service

Token Manager

Documentation for the Configuration Manager Service

Configuration Manager

Documentation for the Storage Service API

Storage Service

Documentation for the Knowledge Base Service

Knowledge Base

Documentation for the Enterprise Search Service

Enterprise Search

Mail Service

Documentation for the PipesHub External Service

PipesHub External Service

PipesHub Internal Services

Configure how users authenticate and access the application

Authentication Overview

Configure how users authenticate and access the application through password

Password

Configure how users authenticate and access the application thorugh OTP

One-Time Password

Configure how users authenticate and access the application using google

Google Authentication

Configure how users authenticate and access the application thorugh microsoft and azure

Microsoft and Azure-Ad

Configure how users authenticate and access the application through Single Sign On

SAML SSO

Configure email capabilities for authentication and notifications

SMTP

Integrate powerful AI models in your PipesHub workspace

AI Models Overview

Configure PipesHub Workplace AI to use different OpenAI models

OpenAI

Configure PipesHub Workplace AI to use different Azure OpenAI models

Azure OpenAI

Configure PipesHub Workplace AI to use different Anthropic Claude models

Anthropic

Configure PipesHub Workplace AI to use different Google Gemini models

Google Gemini

Configure PipesHub Workplace AI to use different Vertex AI models

Vertex AI

Configure PipesHub Workplace AI to use different Ollama models

Ollama

Configure PipesHub Workplace AI to use different Deepseek models

Deepseek

Default embedding model in PipesHub for high-performance text embeddings

BAAI/bge-large-en-v1.5

Configure PipesHub Workplace AI to use OpenAI's embedding models

Configure PipesHub Workplace AI to use Azure OpenAI's embedding models

Configure PipesHub Workplace AI to use Sentence Transformer embedding models

Sentence Transformer

Connectors are software components that enable different applications, systems, or platforms to communicate and share data with each other.

Welcome To PipesHub

System Overview

Authentication

Mail Configuration

AI Providers

Connectors

User Management

Deployment

Developer

Additional Resources

API References

🚧 Coming Soon

We are working hard to bring you this content. Please check back shortly!