mirror of
https://github.com/aiclientproxy/proxycast.git
synced 2026-09-24 23:10:56 +08:00
108 lines
2.3 KiB
Markdown
108 lines
2.3 KiB
Markdown
---
|
|
title: API 概述
|
|
description: ProxyCast API 端点和认证
|
|
navigation:
|
|
icon: i-heroicons-code-bracket
|
|
---
|
|
|
|
# API 概述
|
|
|
|
ProxyCast 提供 OpenAI 和 Claude 兼容的 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` 头：
|
|
|
|
```bash
|
|
curl http://127.0.0.1:8999/v1/chat/completions \
|
|
-H "Authorization: Bearer your-api-key" \
|
|
-H "Content-Type: application/json" \
|
|
-d '...'
|
|
```
|
|
|
|
### Claude 格式
|
|
|
|
使用 `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 | 服务不可用 |
|
|
|
|
## 下一步
|
|
|
|
- [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 集成端点详情
|