API 参考 — 所有端点
GetVibe API 端点的完整列表,包括方法、路径、描述和身份验证类型。端点按类别分组。/v1/* 的基础地址是 https://getvibeapi.com/v1;/api/* 的基础地址是 https://getvibeapi.com。
机器可读的 OpenAPI 3.0 规范位于 /api/openapi,可将其导入 Postman、Swagger UI 或任何兼容 OpenAPI 的工具。
公开目录
/api/catalog、/api/media-catalog 无需密钥即可使用,在注册前可将它们用于店铺、价格计算和模型发现。聊天与补全
| 方法 | 端点 | 描述 | Auth |
|---|---|---|---|
| POST | /v1/chat/completions | 兼容 OpenAI 的聊天端点。 | Bearer |
| POST | /v1/messages | Anthropic Messages 格式的端点。Claude Code 和 Anthropic SDK 使用的路径。 | x-api-key / Bearer |
| POST | /v1/responses | OpenAI Responses API。Codex CLI 的路径(wire_api = "responses")。 | Bearer |
| POST | /v1/messages/count_tokens | 用于 Anthropic SDK / Claude Code 的令牌计数端点存根(仅为估算值,并非精确的分词器结果)。 | x-api-key / Bearer |
模型与价格
| 方法 | 端点 | 描述 | Auth |
|---|---|---|---|
| GET | /v1/models | 可用模型及其类型、模态和端点。按需获取媒体:?type=image、?all=true 或 /v1/models/all;单个模型:/v1/models/{id}。 | Bearer |
| GET | /v1/pricing | 文本模型的规范化程序化价格来源,包括实时运营方覆盖设置。 | Bearer |
| POST | /v1/embeddings | 用于搜索、RAG 和聚类的文本嵌入。 | Bearer |
| POST | /v1/decisions | 根据某个状态评估命名问题(文本->决策)。这不是聊天端点;仅按输入 token 计费。 | Bearer |
媒体
| 方法 | 端点 | 描述 | Auth |
|---|---|---|---|
| POST | /api/media/generate | 异步媒体生成(图像/视频/音频/音乐/3D)。返回用于轮询的 jobId。 | Bearer |
| GET | /api/media/jobs/{id} | 轮询异步媒体生成任务的状态。 | Bearer |
| GET | /api/media/file/{id}/{idx} | 结果的签名代理 URL(HMAC 位于 sig 查询参数中)。无需密钥,可用于嵌入 <img>/<video>。 | sig (HMAC) |
| GET | /api/media-catalog | 公共媒体模型目录:kind、variants、params、fromRub、axes。 | public |
账单与使用情况
| 方法 | 端点 | 描述 | Auth |
|---|---|---|---|
| GET | /v1/balance | 以 USD 计的剩余预付余额。 | Bearer |
| GET | /v1/generations | 包含 route / address_as(公共路由)、request_id 和分页的使用情况历史记录。 | Bearer |
| GET | /v1/generations/{id} | 按 id 获取单条使用历史记录(来自 /v1/generations 响应或 x-pv-generation-id header)。 | Bearer |
| GET | /v1/usage | 按密钥统计使用情况,并包含 route 和 address_as 字段。 | Bearer |
| GET | /api/key/usage | 按密钥汇总:余额、今日/月度支出、请求数。 | Bearer / x-api-key |
路由
| 方法 | 端点 | 描述 | Auth |
|---|---|---|---|
| ANY | x-getvibe-route / x-getvibe-model | 仅供受信任的揭示/调试客户端使用的响应标头:获胜路由的公开 :alias 和 address_as。 | response headers |
调性
| 方法 | 端点 | 描述 | Auth |
|---|---|---|---|
| GET | /v1/keys | 账户的 API 密钥列表。 | Bearer |
| POST | /v1/keys | 无法通过 API 使用。只能在控制面板(Keys 部分)中创建和管理密钥。 | — (UI only) |
支持
| 方法 | 端点 | 描述 | Auth |
|---|---|---|---|
| POST | /v1/tickets | 提交支持工单(JSON 或包含屏幕截图的 multipart)。需要 API key 或控制面板会话。 | Bearer |
| GET | /v1/tickets | 列出你的工单,按最新优先,并使用游标分页。 | Bearer |
| GET | /v1/tickets/{id} | 工单状态以及包含支持回复的完整线程。 | Bearer |
| POST | /v1/tickets/{id}/messages | 向工单添加后续消息。 | Bearer |
| POST | /v1/tickets/{id}/close | 关闭工单。 | Bearer |
| POST | /v1/technical-feedback | POST /v1/tickets 的旧版别名,用于技术报告;字段与之前相同。 | Bearer |
Webhooks
| 方法 | 端点 | 描述 | Auth |
|---|---|---|---|
| GET | /api/webhooks | 当前 webhook URL(mediaWebhookUrl、balanceWebhookUrl)。仅限 Dashboard 会话。 | session (dashboard) |
| PATCH | /api/webhooks | 设置或清除 mediaWebhookUrl / balanceWebhookUrl。仅限 Dashboard 会话。 | session (dashboard) |
公共目录
| 方法 | 端点 | 描述 | Auth |
|---|---|---|---|
| GET | /api/catalog | 公共文本模型目录(无需身份验证)。网站使用它作为商店目录。 | public |
| GET | /api/media-catalog | 公共媒体模型目录(类型、单位价格、参数、轴)。 | public |