> ## Documentation Index
> Fetch the complete documentation index at: https://docs.langbot.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Service API 概述

LangBot 提供了一套供外部服务使用的 RESTful API 接口，便于集成和自动化管理。这些接口以 API Key 鉴权，是目前 HTTP API 的子集。

<Warning>
  Service API 目前处于 Beta 阶段，部分接口可能会频繁变动。
</Warning>

## 获取 API Key

点击 WebUI 侧栏的 `API Keys` 按钮，创建一个 API Key。

<img src="https://mintcdn.com/langbot/BZuGA47SaPPwv_j7/images/zh/api/create_api_key.png?fit=max&auto=format&n=BZuGA47SaPPwv_j7&q=85&s=c77a548f12dd015c9c0234670bd08fb8" alt="create_api_key" width="1442" height="652" data-path="images/zh/api/create_api_key.png" />

创建后，复制 API Key 并保存。

<img src="https://mintcdn.com/langbot/BZuGA47SaPPwv_j7/images/zh/api/copy_api_key.png?fit=max&auto=format&n=BZuGA47SaPPwv_j7&q=85&s=39822fdc8b0aeee63e1e399dc22216bc" alt="copy_api_key" width="912" height="482" data-path="images/zh/api/copy_api_key.png" />

## 认证方式

所有 Service API 都支持以下两种认证方式：

* **API Key**：通过请求头 `X-API-Key: <your-key>` 或 `Authorization: Bearer <your-key>` 传递
* **用户令牌**：通过请求头 `Authorization: Bearer <user-token>` 传递（登录后获取）

## 使用 API

左侧列出了所有可用的 API，您可以填入您的实例地址（后端开放的端口地址，默认为 `http://localhost:5300`）和 API Key，然后点击 `Try it out` 按钮即可调用 API。

## 核心概念

### Provider + Model 架构

LangBot 采用 **供应商（Provider）+ 模型（Model）** 的两层架构来管理 AI 模型：

* **供应商（Provider）**：定义 API 地址（base\_url）、请求器类型（requester）和 API 密钥（api\_keys）。一个供应商可以关联多个模型。
* **模型（Model）**：关联到一个供应商（通过 `provider_uuid`），定义具体的模型名称和参数。模型继承供应商的 API 地址和密钥。

```
Provider (OpenAI)
├── base_url: https://api.openai.com/v1
├── api_keys: [sk-xxx]
├── LLM: gpt-4o
├── LLM: gpt-4o-mini
└── Embedding: text-embedding-3-small
```

这种架构允许您在同一供应商下管理多个模型，共享 API 配置，避免重复填写密钥。

### 请求器（Requester）

请求器定义了与 AI 服务通信的协议。可通过 `GET /api/v1/provider/requesters` 获取可用请求器列表。常见的请求器包括：

* `openai-chat-completions` — OpenAI 兼容的聊天补全 API（也适用于国内服务商如硅基流动、DeepSeek 等）
* `anthropic-messages` — Anthropic Claude API
* `openai-embeddings` — OpenAI 兼容的向量嵌入 API

### 异步任务

部分操作（插件安装/删除/升级）为异步执行，接口返回 `task_id`。可通过 WebUI 查看任务进度。