Introduction

This is the introduction to the DB-GPT API documentation. You can interact with the API through HTTP requests from any language, via our official Python Client bindings.

Authentication

The DB-GPT API uses API keys for authentication. Visit your API Keys page to retrieve the API key you'll use in your requests.

Production requests must be routed through your own backend server where your API key can be securely loaded from an environment variable or key management service.

All API requests should include your API key in an Authorization HTTP header as follows:

Authorization: Bearer DBGPT_API_KEY

Example with the DB-GPT API curl command:

curl "http://localhost:5670/api/v2/chat/completions" \
-H "Authorization: Bearer $DBGPT_API_KEY" \

Example with the DB-GPT Client Python package:

from dbgpt.client import Client

DBGPT_API_KEY = "dbgpt"
client = Client(api_key=DBGPT_API_KEY)

Set the API Key in .env file as follows:

note

API_KEYS - The list of API keys that are allowed to access the API. Each of the below are an option, separated by commas.

API_KEYS=dbgpt

Installation

If you use Python, you should install the official DB-GPT Client package from PyPI:

pip install "dbgpt[client]>=0.5.2"