File size: 1,257 Bytes
4bdb245
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
PrivateGPT provides an **API** containing all the building blocks required to
build **private, context-aware AI applications**.
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](/installation) and then dive into the [API Reference](/api-reference).

## Frequently Visited Resources

<Cards>
  <Card
    title="Main Concepts"
    icon="fa-solid fa-lines-leaning"
    href="/installation"
  />
  <Card
    title="API Reference"
    icon="fa-solid fa-code"
    href="/api-reference"
  />
  <Card
    title="Twitter"
    icon="fa-brands fa-twitter"
    href="https://twitter.com/PrivateGPT_AI"
  />
  <Card
    title="Discord Server"
    icon="fa-brands fa-discord"
    href="https://discord.gg/bK6mRVpErU"
  />
</Cards>

<br />


<Callout intent = "info">
A working **Gradio UI client** is provided to test the API, together with a set of useful tools such as bulk
model download script, ingestion script, documents folder watch, etc.
</Callout>