mirror of
https://github.com/aiclientproxy/proxycast.git
synced 2026-09-24 23:10:56 +08:00
release: v0.68.0
## Features - 版本升级至 0.68.0 ## Fixes - 修复 EmptyState 组件标题排版问题 - 修复"开始生成"按钮文字换行问题 - 修复加载历史对话失败问题 - 修复 parse_message_content 保留 ContentPart 结构 - 修复 convert_agent_message 添加 reasoning_content 处理 - 修复 WorkspaceType::from_str 命名冲突,重命名为 parse ## Code Quality - 修复所有 clippy 警告 - 修复 manual_flatten 警告 - 修复 ptr_arg 警告(使用 &Path 替代 &PathBuf) - 修复 manual_clamp 警告 - 修复 match_single_binding 警告 - 所有测试通过 (174 passed)
This commit is contained in:
@@ -1,107 +1,55 @@
|
||||
---
|
||||
title: API 概述
|
||||
description: ProxyCast API 端点和认证
|
||||
title: API 概览
|
||||
description: 面向进阶用户的本地接口能力说明
|
||||
navigation:
|
||||
icon: i-heroicons-code-bracket
|
||||
---
|
||||
|
||||
# API 概述
|
||||
# API 概览
|
||||
|
||||
ProxyCast 提供 OpenAI 和 Claude 兼容的 API 端点。
|
||||
::alert{type="info"}
|
||||
本章节面向进阶用户与开发者。普通创作者可直接在应用内使用,无需 API 接入。
|
||||
::
|
||||
|
||||
## 支持的端点
|
||||
当你需要把 ProxyCast 接入脚本、自动化流程或第三方工具时,可使用本地 API。
|
||||
|
||||
### OpenAI 兼容
|
||||
## 常见端点类型
|
||||
|
||||
| 端点 | 方法 | 说明 |
|
||||
|------|------|------|
|
||||
| `/v1/chat/completions` | POST | 聊天补全 |
|
||||
| `/v1/models` | GET | 模型列表 |
|
||||
| `/v1/embeddings` | POST | 文本嵌入 |
|
||||
### 通用对话端点
|
||||
|
||||
### Claude 兼容
|
||||
用于文本生成、对话续写等任务。
|
||||
|
||||
| 端点 | 方法 | 说明 |
|
||||
|------|------|------|
|
||||
| `/v1/messages` | POST | 消息 API |
|
||||
| `/v1/messages/count_tokens` | POST | Token 计数 |
|
||||
### 模型与管理端点
|
||||
|
||||
### Amp CLI 路由
|
||||
用于读取模型列表、状态信息和部分管理能力。
|
||||
|
||||
| 端点 | 方法 | 说明 |
|
||||
|------|------|------|
|
||||
| `/api/provider/{provider}/v1/chat/completions` | POST | Amp 聊天补全 |
|
||||
| `/api/provider/{provider}/v1/messages` | POST | Amp 消息 API |
|
||||
| `/api/auth/*` | ANY | Amp 认证代理 |
|
||||
| `/api/user/*` | ANY | Amp 用户代理 |
|
||||
### 扩展端点
|
||||
|
||||
### 管理 API
|
||||
|
||||
| 端点 | 方法 | 说明 |
|
||||
|------|------|------|
|
||||
| `/v0/management/status` | GET | 服务器状态 |
|
||||
| `/v0/management/credentials` | GET/POST/DELETE | 凭证管理 |
|
||||
| `/v0/management/config` | GET/PUT | 配置管理 |
|
||||
用于特定平台或集成场景。
|
||||
|
||||
## 认证方式
|
||||
|
||||
### OpenAI 格式
|
||||
- `Authorization: Bearer <api-key>`
|
||||
- 或使用兼容格式的密钥头
|
||||
|
||||
使用 `Authorization` 头:
|
||||
请确保 API Key 仅在可信环境使用。
|
||||
|
||||
```bash
|
||||
curl http://127.0.0.1:8999/v1/chat/completions \
|
||||
-H "Authorization: Bearer your-api-key" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '...'
|
||||
```
|
||||
## 默认地址
|
||||
|
||||
### Claude 格式
|
||||
默认本地地址:`http://127.0.0.1:8999`
|
||||
|
||||
使用 `x-api-key` 头:
|
||||
通常建议保持本地监听,不对公网暴露。
|
||||
|
||||
```bash
|
||||
curl http://127.0.0.1:8999/v1/messages \
|
||||
-H "x-api-key: your-api-key" \
|
||||
-H "anthropic-version: 2023-06-01" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '...'
|
||||
```
|
||||
## 错误排查建议
|
||||
|
||||
## 基础 URL
|
||||
|
||||
默认地址:`http://127.0.0.1:8999`
|
||||
|
||||
可在设置中修改主机和端口。
|
||||
|
||||
## 错误响应
|
||||
|
||||
### 错误格式
|
||||
|
||||
```json
|
||||
{
|
||||
"error": {
|
||||
"message": "错误描述",
|
||||
"type": "error_type",
|
||||
"code": "error_code"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 常见错误码
|
||||
|
||||
| 状态码 | 说明 |
|
||||
|--------|------|
|
||||
| 400 | 请求格式错误 |
|
||||
| 401 | 认证失败 |
|
||||
| 404 | 端点不存在 |
|
||||
| 429 | 速率限制 |
|
||||
| 500 | 服务器错误 |
|
||||
| 503 | 服务不可用 |
|
||||
- `401`:密钥错误或请求头格式错误
|
||||
- `404`:端点路径错误
|
||||
- `429`:请求频率过高
|
||||
- `5xx`:服务端异常或上游波动
|
||||
|
||||
## 下一步
|
||||
|
||||
- [OpenAI API](/api-reference/openai-api) - OpenAI 兼容端点详情
|
||||
- [Claude API](/api-reference/claude-api) - Claude 兼容端点详情
|
||||
- [管理 API](/api-reference/management-api) - 远程管理端点详情
|
||||
- [Amp CLI API](/api-reference/amp-cli-api) - Amp CLI 集成端点详情
|
||||
- [OpenAI API](/api-reference/openai-api)
|
||||
- [Claude API](/api-reference/claude-api)
|
||||
- [管理 API](/api-reference/management-api)
|
||||
- [Amp CLI API](/api-reference/amp-cli-api)
|
||||
|
||||
@@ -7,6 +7,10 @@ navigation:
|
||||
|
||||
# OpenAI API
|
||||
|
||||
::alert{type="info"}
|
||||
本页是开发者进阶文档。普通创作者可直接在应用内使用,无需 API 调用。
|
||||
::
|
||||
|
||||
ProxyCast 提供完整的 OpenAI Chat Completions API 兼容。
|
||||
|
||||
## /v1/chat/completions
|
||||
|
||||
@@ -7,6 +7,10 @@ navigation:
|
||||
|
||||
# Claude API
|
||||
|
||||
::alert{type="info"}
|
||||
本页是开发者进阶文档。普通创作者可直接在应用内使用,无需 API 调用。
|
||||
::
|
||||
|
||||
ProxyCast 提供 Anthropic Claude Messages API 兼容。
|
||||
|
||||
## /v1/messages
|
||||
|
||||
@@ -7,6 +7,10 @@ navigation:
|
||||
|
||||
# 管理 API
|
||||
|
||||
::alert{type="info"}
|
||||
本页是开发者进阶文档,主要用于自动化管理与运维集成。
|
||||
::
|
||||
|
||||
ProxyCast 提供远程管理 API,用于配置和监控服务。
|
||||
|
||||
## 认证
|
||||
|
||||
@@ -7,6 +7,10 @@ navigation:
|
||||
|
||||
# Amp CLI API
|
||||
|
||||
::alert{type="info"}
|
||||
本页是开发者进阶文档。若你不涉及 Amp CLI 集成,可跳过。
|
||||
::
|
||||
|
||||
ProxyCast 提供 Amp CLI 兼容的路由端点,支持将 Amp CLI 请求路由到本地 OAuth 凭证。
|
||||
|
||||
## 概述
|
||||
|
||||
Reference in New Issue
Block a user