For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact usJoin the Discord
OverviewQuickstartInstallationManualRecipesAPI Reference
  • Welcome
    • Introduction
LogoLogo
Contact usJoin the Discord
On this page
  • Frequently Visited Resources
Welcome

Introduction

Was this page helpful?
Built with

PrivateGPT provides an API containing all the building blocks required to build private, context-aware AI applications.

If you are looking for an enterprise-ready, fully private AI workspace check out Zylon’s website or request a demo. Crafted by the team behind PrivateGPT, Zylon is a best-in-class AI collaborative workspace that can be easily deployed on-premise (data center, bare metal…) or in your private cloud (AWS, GCP, Azure…).

The API follows and extends OpenAI API standard, and supports both normal and streaming responses. That means that, if you can use OpenAI API in one of your tools, you can use your own PrivateGPT API instead, with no code changes, and for free if you are running PrivateGPT in a local setup.

Get started by understanding the Main Concepts and Installation and then dive into the API Reference.

Frequently Visited Resources

Main Concepts
API Reference
Twitter
Discord Server