代理 API 参考
代理 API 是 AISIX 在代理监听端口上暴露给调用方的 API 面。应用可以继续使用已有请求格式,AISIX 负责执行认证、模型解析、流量控制和服务提供方调度。
开源 AISIX 网关和连接到 AISIX Cloud 的 AISIX 网关使用相同的代理 API 面。运维人员配置资源的方式不同,但调用方使用的网关路由相同。AISIX Cloud 还提供预算等控制面功能。
本参考说明 AISIX 的路由行为、认证、模型发现、路由选择和端点约束。代理请求和响应体遵循各路由对应的 API 族;需要完整正文结构时,请参考对应上游 API 文档。
在 AISIX 中,面向客户端的路由路径由 AI API 形态决定,而不是为每个上游自定义路径。应用直接调用受支持的代理端点。请求中的 model 值会选择已配置的 AISIX 模型别名,进而决定请求背后的服务提供方密钥、上游模型、路由行为和流量控制。
代理路由
| 方法 | 路由 | 说明 |
|---|---|---|
GET | /v1/models | 列出该调用方 API Key 可以请求的模型别名,包括虚拟别名。通配符别名不会展示。 |
POST | /v1/chat/completions | OpenAI 兼容 Chat Completions,支持的服务提供方范围最广。 |
POST | /v1/completions | OpenAI 兼容文本补全。 |
POST | /v1/messages | Anthropic 风格 Messages。Anthropic 上游使用原生格式,非 Anthropic 上游通过转换支持。 |
POST | /v1/messages/count_tokens | Anthropic 风格 Token 计数,仅支持 Anthropic 上游目标。 |
POST | /v1/embeddings | 向量嵌入,仅支持 OpenAI 协议族适配器。 |
POST | /v1/responses | OpenAI Responses API。OpenAI 上游直接转发,非 OpenAI 上游通过服务提供方适配器桥接。 |
POST | /v1/images/generations | 图像生成。解析出的模型必须配置为 provider: "openai"。 |
POST | /v1/videos | 提交异步视频生成任务。支持 alibaba、zhipuai(或 zhipu)、volcengine、runwayml(或 runway)和 openai 服务提供方标签。 |
GET | /v1/videos/{video_id} | 轮询视频生成任务。 |
GET | /v1/videos/{video_id}/content | 下载已完成的视频结果。 |
POST | /v1/audio/transcriptions | 语音转文本。转发到上游 OpenAI 风格音频路由。 |
POST | /v1/audio/translations | 语音翻译。转发到上游 OpenAI 风格音频路由。 |
POST | /v1/audio/speech | 文本转语音。转发到上游 OpenAI 风格音频路由。 |
GET | /v1/realtime | OpenAI Realtime WebSocket 中继。要求使用直接模型,并在升级连接前完成身份认证。 |
POST | /v1/rerank | 重排序。仅支持 openai、cohere 和 jina 服务提供方标签。 |
POST、GET | /v1/files | 上传文件或列出文件。 |
GET、DELETE | /v1/files/{id} | 获取或删除文件。 |
GET | /v1/files/{id}/content | 下载文件内容。 |
POST、GET | /v1/batches | 创建 Batch 或列出 Batch。 |
GET | /v1/batches/{id} | 获取 Batch。 |
POST | /v1/batches/{id}/cancel | 取消 Batch。 |
POST、GET | /v1/fine_tuning/jobs | 创建 Fine-tuning Job 或列出 Job。 |
GET | /v1/fine_tuning/jobs/{id} | 获取 Fine-tuning Job。 |
POST | /v1/fine_tuning/jobs/{id}/cancel | 取消 Fine-tuning Job。 |
ANY | 已配置的透传路由 | 在每条路由的路径前缀和/或入 站 Host 白名单上做原生转发,包含网关认证和有限的网关标准化处理。未匹配任何类型端点或显式透传路由的请求会按普通流程返回响应体为空的 404。 |
ANY | /mcp 和 /mcp/ | MCP 网关端点。认证调用方,列出允许访问的工具,并将工具调用路由到已注册的上游 MCP 服务器。 |
ANY | /mcp/{server} | 单服务器 MCP 端点。通常公开原始工具名称;需要避免命名冲突时保留当前服务器前缀。 |
POST | /a2a/{agent} | 一个已注册 Agent 的 A2A JSON-RPC 端点。转发前会执行调用方 Key 的 Agent 访问控制。 |
GET | /a2a/{agent}/.well-known/agent-card.json | 获取已注册 Agent 的 Agent Card,并把其服务 URL 重写为网关地址。要求调用方完成身份认证并具有 Agent 访问权限。 |
GET | /livez | 无需认证的存活探针,用于确认代理监听端口已启动。优雅关闭期间保持返回 200——正在排空的实例是健康的、不应被重启;检测排空状态请使用 /readyz。 |
GET | /readyz | 无需认证的就绪探针。实例正在排空时返回 503。对于使用 etcd 或 AISIX Cloud 的网关,首次应用配置之前整个代理监听器都未绑定,因此在那之前该路由是被拒绝而不是返回响应;参见启动与第一个配置。 |
认证
代理请求接受调用 方 API Key,或由已配置的 OpenID Connect(OIDC)提供方签发的 JWT。两种方法都会将请求解析到调用方 API Key 资源。解析出的 Key 决定应用哪些模型和工具允许列表、限流,以及其他访问和流量控制;使用 AISIX Cloud 时,还会应用匹配的预算。
调用方 API Key
通过 AISIX Cloud 控制面创建调用方 API Key,或在开源 AISIX 网关的 resources.yaml 文件中声明调用方 API Key。
推荐格式:
Authorization: Bearer <plaintext-caller-key>
备用格式:
x-api-key: <plaintext-caller-key>
调用方 API Key 是 AISIX 网关凭证,不是上游服务提供方密钥。