API-Zeno 文档中心

选择你要接入的能力

从左侧选择配置项或接口类别,右侧查看 API-Zeno 的鉴权方式、Base URL、请求路径、示例代码和能力边界。

入门配置

api-zeno 个人用户操作指南

面向个人用户,说明账户注册、额度购买、API Key 创建、参数配置、接入信息填写及故障排查等操作。

方法

GUIDE

接口

控制台 / API 密钥

Base URL

https://api-zeno.com/v1

鉴权

api-zeno 账户登录

说明

  • 先注册 api-zeno 账户并完成邮箱验证。
  • 按需购买套餐或开通按量计费,确认账户有可用额度。
  • 在 API 密钥页面创建 Key,并配置分组、额度、有效期和权限。
  • 把 API Key 与 Base URL 填入支持 OpenAI 兼容接口的工具或客户端。

一、文档说明

本文档面向 api-zeno 个人用户,主要说明平台账户注册、额度购买、API Key 创建、参数配置、接入信息填写及故障排查等操作。

api-zeno 智能化平台提供 API Key 创建与删除、启用状态设置、有效期设置、余额及额度配置、调用用量查询、权限配置、API Key 批量创建与管理等能力。

  • Codex 自动安装与升级脚本
  • Claude 自动安装与升级脚本
  • Codex 汉化脚本
  • zeno 一键配置脚本

相关链接:https://api-zeno.com/zh-CN

二、注册 api-zeno 账户

API Key 的创建、配置和使用需要通过 api-zeno 智能化平台完成。使用相关功能前,个人用户需先注册 api-zeno 平台账户。

  1. 1进入 api-zeno 官网,点击注册入口,进入账户注册页面。
  2. 2根据页面提示填写昵称、邮箱地址和登录密码。
  3. 3填写完成后,按页面提示完成人机验证。
  4. 4根据页面提示重新登录并获取邮箱验证码。
  5. 5前往邮箱查收验证码,然后返回注册页面填写验证码并提交。
  6. 6注册完成后,使用注册邮箱和密码登录 api-zeno 智能化平台。

三、购买套餐或开通按量计费

登录平台后,可根据实际使用需求选择套餐计费或按量计费。套餐计费用于购买固定规格额度,按量计费会根据接口实际调用量扣除账户余额。

  1. 1进入平台控制台,查看按量计费和购买套餐模块展示的价格及套餐信息。
  2. 2根据实际需求选择对应的计费方式,并按照页面提示完成订阅或购买。
  3. 3购买完成后,进入控制台页面查看账户余额、可用额度及相关订单记录。

个人用户可根据页面提示进行充值。具体充值金额、到账额度及计费规则,以平台页面展示的信息为准。

四、创建 API Key

完成账户充值或套餐购买后,可在 api-zeno 智能化平台中创建 API Key。

  1. 1进入 API 密钥管理页面。
  2. 2点击创建 Key 按钮,进入 API Key 创建页面。
  3. 3按页面字段填写 API Key 名称、分组、剩余额度、过期时间、RPM、TPM、模型白名单和 IP 白名单。
  4. 4配置完成后,保存设置并返回 API Key 列表。

API Key 创建配置项

配置项是否必填说明
API Key 名称是用于识别当前 API Key
分组是选择 API Key 所属分组
剩余额度是设置 API Key 的可用额度
过期时间否设置 API Key 的失效时间
RPM否设置每分钟请求次数限制
TPM否设置每分钟 Token 数量限制
模型白名单否设置该 API Key 可调用的模型
IP 白名单否设置允许调用该 API Key 的 IP 地址

使用前检查

检查项检查内容
Key 状态API Key 是否处于启用状态
有效期过期时间是否设置正确
余额可用余额是否已配置
调用限制RPM、TPM 等限制是否符合配置要求
模型权限模型白名单是否已设置
IP 权限IP 白名单是否已设置
标识信息API Key 名称和分组是否填写正确

五、复制 API Key 并配置接入信息

API Key 创建并配置完成后,系统会生成对应的 API Key。使用接口时,需要同时配置 API Key 和统一的 Base URL。

  1. 1进入 API 密钥页面。
  2. 2打开密钥清单,查看当前账户已创建的全部 API Key。
  3. 3找到需要使用的 API Key,单击对应的复制按钮。
  4. 4将 API Key 与统一的 Base URL 一并填写到使用的工具或客户端中。
text
Base URL:
https://api-zeno.com/v1

API Key:
请填写平台生成的 API Key

六、API Key 数据记录

平台提供 API Key 的基础数据及状态信息。如需在平台外建立补充记录,可使用以下字段。相关额度、用量和状态数据以平台显示结果为准。

字段内容
Key 名称API Key 的名称或识别标记
API Key平台生成的接口访问凭证
分组API Key 所属分组
创建时间API Key 的创建日期和时间
生效时间API Key 的开始生效时间
到期时间API Key 的失效时间
初始额度API Key 创建或充值时配置的额度
剩余额度API Key 当前可用额度
调用用量API Key 已产生的调用量
RPM每分钟请求次数限制
TPM每分钟 Token 数量限制
模型白名单API Key 可调用的模型范围
IP 白名单允许调用 API Key 的 IP 地址范围
当前状态启用、停用或已过期
备注其他补充说明

七、使用注意事项

API Key 属于接口访问凭证,不应出现在公开网页、公开代码仓库、公开文档、未脱敏截图、客户端日志或故障记录中。

  • 如需展示 API Key,应隐藏中间字符,例如 sk-zeno-abc********xyz。
  • 使用前确认 API Key 复制完整、处于启用状态、在有效期内且具有可用余额。
  • 确认 Base URL 填写完整,RPM、TPM、模型白名单和 IP 白名单符合接入要求。
  • 用量查询可进入 API 密钥管理页面,选择对应 API Key 查看状态、剩余额度、调用用量、到期时间和权限配置。
  • 需要修改额度或有效期时,进入对应 API Key 的配置页面修改并保存。
  • API Key 不再使用时,可在管理页面将其状态设置为停用。

八、故障排查

使用时如果遇到接口无法调用,可按照以下顺序进行检查:

  1. 1Base URL 是否为 https://api-zeno.com/v1。
  2. 2API Key 是否复制完整,前后是否包含空格、换行或其他不可见字符。
  3. 3API Key 是否处于启用状态,当前时间是否在有效期内,且是否具有可用余额。
  4. 4RPM 或 TPM 是否达到当前限制。
  5. 5API Key 是否具有对应模型的调用权限。
  6. 6当前调用 IP 是否在 IP 白名单范围内。
  7. 7使用的工具或客户端是否支持 OpenAI 兼容接口。
  8. 8当前网络是否能够访问 Base URL。
  9. 9接口返回信息中是否包含 HTTP 状态码和错误内容。
text
调用时间:
使用工具或客户端:
请求地址:
请求接口:
模型名称:
HTTP 状态码:
错误信息:
API Key 名称:
API Key 末尾字符:

API Key 标识可记录 Key 名称或末尾部分,不应在故障记录、截图或公开文档中填写完整 API Key。

入门配置

快速开始

用一个 Chat Completions 请求确认 Key、额度、模型和渠道都可用。

方法

POST

接口

/v1/chat/completions

Base URL

https://api.api-zeno.com/v1

鉴权

Authorization: Bearer $API_ZENO_KEY

说明

  • 在控制台创建 API Key。
  • 把 SDK 或工具的 Base URL 改成 https://api.api-zeno.com/v1。
  • 先用小模型跑通一次请求,再接入生产业务。

示例

bash
curl https://api.api-zeno.com/v1/chat/completions \
  -H "Authorization: Bearer $API_ZENO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [
      { "role": "user", "content": "Hello API-Zeno" }
    ]
  }'

入门配置

鉴权与 Base URL

模型网关统一使用 API Key 鉴权;控制台接口使用用户会话或管理员会话。

方法

HEADER

接口

Authorization

Base URL

https://api.api-zeno.com/v1

鉴权

Bearer API Key

说明

  • 模型调用:Authorization: Bearer $API_ZENO_KEY。
  • OpenAI 兼容路径:https://api.api-zeno.com/v1。
  • Gemini 兼容路径:https://api.api-zeno.com/v1beta。
  • 控制台和后台接口不使用模型 API Key,使用登录会话权限。

模型网关

Chat Completions

兼容 OpenAI Chat Completions SDK,适合文本对话、工具调用、JSON 输出和常规应用接入。

方法

POST

接口

/v1/chat/completions

Base URL

https://api.api-zeno.com/v1

鉴权

Authorization: Bearer $API_ZENO_KEY

说明

  • 模型名必须在后台模型、渠道或账号池中配置。
  • 请求会进入 API-Zeno 的额度、日志、渠道调度和计费流程。
  • 可按后台配置路由到不同上游协议。

示例

typescript
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.API_ZENO_KEY,
  baseURL: "https://api.api-zeno.com/v1",
});

const result = await client.chat.completions.create({
  model: "gpt-4o-mini",
  messages: [{ role: "user", content: "Hello API-Zeno" }],
});

console.log(result.choices[0]?.message?.content);
python
from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_ZENO_KEY",
    base_url="https://api.api-zeno.com/v1",
)

result = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Hello API-Zeno"}],
)

print(result.choices[0].message.content)

模型网关

Responses

适合新式 Responses 调用、工具、多模态输入和需要保持 Responses 结构的客户端。

方法

POST

接口

/v1/responses

Base URL

https://api.api-zeno.com/v1

鉴权

Authorization: Bearer $API_ZENO_KEY

说明

  • 支持普通响应和流式响应。
  • 可配合 Sticky Session、Responses WebSocket 等兼容能力。
  • 也提供 /v1/responses/compact 作为紧凑辅助入口。

示例

bash
curl https://api.api-zeno.com/v1/responses \
  -H "Authorization: Bearer $API_ZENO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o-mini",
    "input": "Summarize API-Zeno in one paragraph"
  }'

协议接口

Claude Messages

保持 Claude Messages 请求结构,通过 API-Zeno 的 Key、额度、日志和渠道调度访问。

方法

POST

接口

/v1/messages

Base URL

https://api.api-zeno.com/v1

鉴权

Authorization: Bearer $API_ZENO_KEY

说明

  • 请求体保持 Messages 格式。
  • 模型名和渠道能力必须在后台配置。
  • 这是 native passthrough,不等同于所有协议之间的任意转换。

示例

bash
curl https://api.api-zeno.com/v1/messages \
  -H "Authorization: Bearer $API_ZENO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-6",
    "max_tokens": 256,
    "messages": [
      { "role": "user", "content": "Hello Claude" }
    ]
  }'

协议接口

Gemini generateContent

提供 Gemini 风格 generateContent 和 streamGenerateContent 入口,仍由 API-Zeno API Key 鉴权。

方法

POST

接口

/v1beta/models/{model}:generateContent

Base URL

https://api.api-zeno.com/v1beta

鉴权

Authorization: Bearer $API_ZENO_KEY

说明

  • 支持 generateContent 和 streamGenerateContent。
  • 模型参数写在路径中,例如 /models/gemini-2.0-flash:generateContent。
  • 上游账号、渠道和分组由后台配置决定。

示例

bash
curl https://api.api-zeno.com/v1beta/models/gemini-2.0-flash:generateContent \
  -H "Authorization: Bearer $API_ZENO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": [
      { "role": "user", "parts": [{ "text": "Hello Gemini" }] }
    ]
  }'

协议接口

Embeddings

用于向量化文本、检索、RAG 入库和相似度计算前置处理。

方法

POST

接口

/v1/embeddings

Base URL

https://api.api-zeno.com/v1

鉴权

Authorization: Bearer $API_ZENO_KEY

说明

  • Embedding 模型需要单独配置价格、渠道和模型权限。
  • 调用记录会进入日志和额度统计。

示例

bash
curl https://api.api-zeno.com/v1/embeddings \
  -H "Authorization: Bearer $API_ZENO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "text-embedding-3-small",
    "input": "API-Zeno protocol coverage"
  }'

多媒体

图像生成与编辑

提供图像生成、图像编辑、图像变体等 OpenAI 风格路径。

方法

POST

接口

/v1/images/generations

Base URL

https://api.api-zeno.com/v1

鉴权

Authorization: Bearer $API_ZENO_KEY

说明

  • 常用路径:/v1/images/generations、/v1/images/edits、/v1/images/variations。
  • 具体参数取决于上游模型和后台渠道配置。
  • 图像能力也可在创作工作台中以任务方式使用。

示例

bash
curl https://api.api-zeno.com/v1/images/generations \
  -H "Authorization: Bearer $API_ZENO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-image-1",
    "prompt": "A clean API gateway diagram",
    "size": "1024x1024"
  }'

多媒体

音频接口

支持语音合成、语音转文本和翻译类音频入口。

方法

POST

接口

/v1/audio/speech

Base URL

https://api.api-zeno.com/v1

鉴权

Authorization: Bearer $API_ZENO_KEY

说明

  • 常用路径:/v1/audio/speech、/v1/audio/transcriptions、/v1/audio/translations。
  • 文件上传类接口使用 multipart/form-data。

示例

bash
curl https://api.api-zeno.com/v1/audio/speech \
  -H "Authorization: Bearer $API_ZENO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "tts-1",
    "voice": "alloy",
    "input": "API-Zeno is ready."
  }' --output speech.mp3

多媒体

视频任务

提交视频生成任务,并通过任务状态接口查询结果。

方法

POST

接口

/v1/video/generations

Base URL

https://api.api-zeno.com/v1

鉴权

Authorization: Bearer $API_ZENO_KEY

说明

  • 提交任务:POST /v1/video/generations。
  • 查询任务:GET /v1/video/generations/{task_id}。
  • 具体模型能力、任务字段和返回结构取决于已配置上游。

示例

bash
curl https://api.api-zeno.com/v1/video/generations \
  -H "Authorization: Bearer $API_ZENO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "kling-v1",
    "prompt": "A clean product walkthrough video for an API gateway"
  }'

协议接口

Rerank

用于检索结果重排、知识库召回排序和搜索增强。

方法

POST

接口

/v1/rerank

Base URL

https://api.api-zeno.com/v1

鉴权

Authorization: Bearer $API_ZENO_KEY

说明

  • 请求包含 query 和 documents。
  • 模型、价格和渠道需在后台配置。

示例

bash
curl https://api.api-zeno.com/v1/rerank \
  -H "Authorization: Bearer $API_ZENO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "bge-reranker-large",
    "query": "gateway billing trace",
    "documents": [
      "API logs include request_id and channel_id.",
      "Frontend theme settings are stored locally."
    ]
  }'

控制台接口

用户控制台接口

用户登录后管理个人资料、API Key、额度、日志、钱包、订阅和创作任务。

方法

SESSION

接口

/api/console/*

Base URL

https://api.api-zeno.com

鉴权

用户登录会话

说明

  • /api/console/profile:用户资料。
  • /api/console/keys:API Key 列表、创建、修改、禁用、删除。
  • /api/console/billing-groups:可用分组。
  • /api/console/quota/today:今日额度。
  • /api/console/logs:调用日志。
  • /api/console/wallet、/api/console/subscription:钱包和订阅。

控制台接口

后台运营接口

管理员维护渠道、账号池、模型价格、日志、风控、系统设置和运营数据。

方法

SESSION

接口

/api/admin/*

Base URL

https://api.api-zeno.com

鉴权

管理员登录会话

说明

  • /api/admin/channels:渠道与密钥池。
  • /api/admin/accounts:账号池。
  • /api/admin/pricing:模型价格。
  • /api/admin/logs:请求日志。
  • /api/admin/monitor:运行监控。
  • /api/admin/ops:风险与运营概览。
  • /api/admin/system:系统配置。

合作入口

api-zeno 合作伙伴操作指南

面向 api-zeno 合作伙伴,说明账户注册、额度购买、API Key 创建、参数配置、接入信息分发及故障排查等操作。

方法

GUIDE

接口

控制台 / API 密钥

Base URL

https://apiway.top/v1

鉴权

api-zeno 账户登录

说明

  • 先注册 api-zeno 账户,再按需求购买套餐或开通按量计费。
  • 在 API 密钥页面创建 Key,并配置分组、额度、有效期、RPM、TPM、模型白名单和 IP 白名单。
  • 分发给客户时同时提供 API Key 与统一 Base URL:https://apiway.top/v1。
  • 故障排查时只记录 Key 名称或末尾字符,不要在截图、日志或公开文档中暴露完整 API Key。

一、文档说明

本文档面向 api-zeno 合作伙伴,主要说明平台账户注册、额度购买、API Key 创建、参数配置、接入信息分发及故障排查等操作。

api-zeno 智能化平台提供以下 API Key 管理功能:

  • API Key 创建与删除
  • API Key 启用状态设置
  • 有效期设置
  • 余额及额度配置
  • 调用用量查询
  • 权限配置
  • API Key 批量创建与分发

平台提供的技术工具

  • Codex 自动安装与升级脚本
  • Claude 自动安装与升级脚本
  • Codex 汉化脚本
  • zeno 一键配置脚本

相关链接:https://api-zeno.com/zh-CN

二、注册 api-zeno 账户

API Key 的创建、配置和分发需要通过 api-zeno 智能化平台完成。使用相关功能前,合作伙伴需先注册 api-zeno 平台账户。

  1. 1进入 api-zeno 官网,点击注册入口,进入账户注册页面。
  2. 2根据页面提示填写昵称、邮箱地址和登录密码。
  3. 3填写完成后,按页面提示完成人机验证。
  4. 4根据页面提示重新登录并获取邮箱验证码,系统会向注册邮箱发送验证码。
  5. 5前往邮箱查收验证码,然后返回注册页面填写验证码并提交。
  6. 6注册完成后,使用注册邮箱和密码登录 api-zeno 智能化平台。

三、购买套餐或开通按量计费

登录平台后,可根据实际使用需求选择套餐计费或按量计费。

套餐计费适合购买平台提供的固定规格使用额度;按量计费会根据接口实际调用量扣除账户余额。

  1. 1进入平台控制台,查看按量计费和购买套餐模块展示的价格及套餐信息。
  2. 2根据实际需求选择对应的计费方式,并按照页面提示完成订阅或购买。
  3. 3购买完成后,进入控制台页面查看账户余额、可用额度及相关订单记录。

合作伙伴也可联系 zeno 专属客服进行充值。具体充值金额、到账额度及计费规则,以平台页面或客服提供的信息为准。

四、创建 API Key

完成账户充值或套餐购买后,可在 api-zeno 智能化平台中创建 API Key。

  1. 1进入 API 密钥管理页面。
  2. 2点击创建 Key 按钮,进入 API Key 创建页面。
  3. 3根据页面字段填写或设置 API Key 名称、分组、剩余额度、过期时间、RPM、TPM、模型白名单和 IP 白名单。
  4. 4配置完成后,保存设置并返回 API Key 列表。

API Key 创建配置项

配置项是否必填说明
API Key 名称是用于识别当前 API Key
分组是选择 API Key 所属分组
剩余额度是设置 API Key 的可用额度
过期时间否设置 API Key 的失效时间
RPM否设置每分钟请求次数限制
TPM否设置每分钟 Token 数量限制
模型白名单否设置该 API Key 可调用的模型
IP 白名单否设置允许调用该 API Key 的 IP 地址

分发前检查

检查项检查内容
Key 状态API Key 是否处于启用状态
有效期过期时间是否设置正确
余额可用余额是否已配置
调用限制RPM、TPM 等限制是否符合配置要求
模型权限模型白名单是否已设置
IP 权限IP 白名单是否已设置
标识信息API Key 名称和分组是否填写正确

五、复制 API Key 并分发接入信息

API Key 创建并配置完成后,系统会生成对应的 API Key。使用接口时,需要同时配置 API Key 和统一的 Base URL。

  1. 1进入 API 密钥页面。
  2. 2打开密钥清单,页面将展示当前账户已创建的全部 API Key。
  3. 3找到需要分发的 API Key,单击对应的复制按钮。
  4. 4将 API Key 与统一的 Base URL 一并提供给使用方。
text
Base URL:
https://apiway.top/v1

API Key:
请填写平台生成的 API Key

Base URL 为 https://apiway.top/v1。该地址为 API 接口地址,不是普通网页地址,直接通过浏览器访问返回 404 属于正常情况,不表示 API 服务不可用。

常见接入字段名称

  • Base URL
  • API Base
  • API Endpoint
  • OpenAI Base URL
  • API Key
  • Token

不同工具中的字段名称可能有所不同,具体字段名称以实际工具或客户端页面为准。

六、API Key 数据记录

平台提供 API Key 的基础数据及状态信息。如需在平台外建立补充记录,可使用以下字段。相关额度、用量和状态数据以平台显示结果为准。

字段内容
Key 名称API Key 的名称或识别标记
API Key平台生成的接口访问凭证
分组API Key 所属分组
创建时间API Key 的创建日期和时间
生效时间API Key 的开始生效时间
到期时间API Key 的失效时间
初始额度API Key 创建或充值时配置的额度
剩余额度API Key 当前可用额度
调用用量API Key 已产生的调用量
RPM每分钟请求次数限制
TPM每分钟 Token 数量限制
模型白名单API Key 可调用的模型范围
IP 白名单允许调用 API Key 的 IP 地址范围
当前状态启用、停用或已过期
备注其他补充说明

七、使用注意事项

API Key 属于接口访问凭证,不应出现在公开网页、公开代码仓库、公开文档、未脱敏截图、客户端日志或故障记录中。

  • 如需在文档或截图中展示 API Key,应隐藏中间字符,例如 sk-zeno-abc********xyz。
  • 分发前检查 API Key 是否复制完整、处于启用状态、在有效期内且具有可用余额。
  • 确认 Base URL 填写完整,RPM、TPM、模型白名单和 IP 白名单符合接入要求。
  • 用量查询可进入 API 密钥管理页面,查看状态、剩余额度、调用用量、到期时间、RPM、TPM、模型及 IP 权限。
  • 需要修改额度或有效期时,进入对应 API Key 的配置页面修改并保存;修改完成后重新进入详情页确认数据更新。
  • API Key 不再使用时,可在管理页面将其状态设置为停用,停用后该 Key 将无法继续调用接口。

八、故障排查

使用方反馈接口无法调用时,可按照以下顺序进行检查:

  1. 1Base URL 是否为 https://apiway.top/v1。
  2. 2API Key 是否复制完整,前后是否包含空格、换行或其他不可见字符。
  3. 3API Key 是否处于启用状态,当前时间是否在有效期内,且是否具有可用余额。
  4. 4RPM 或 TPM 是否达到当前限制。
  5. 5API Key 是否具有对应模型的调用权限。
  6. 6当前调用 IP 是否在 IP 白名单范围内。
  7. 7使用的工具或客户端是否支持 OpenAI 兼容接口。
  8. 8当前网络是否能够访问 Base URL。
  9. 9接口返回信息中是否包含 HTTP 状态码和错误内容。
text
调用时间:
使用工具或客户端:
请求地址:
请求接口:
模型名称:
HTTP 状态码:
错误信息:
API Key 名称:
API Key 末尾字符:

API Key 标识可记录 Key 名称或末尾部分,不应在故障记录、截图或公开文档中填写完整 API Key。