适用场景一言简版API 返回随机的中文句子适合在站点页脚、小程序欢迎语、控制台启动提示或任何需要“一句话点缀”的场景中嵌入。本指南面向已经或准备使用该接口的开发者重点解决接入过程中最容易遇到的故障而非介绍功能本身。接口能力边界请求方法GET地址https://v1.apizero.cn/api/yiyanQPS每秒请求配额20 次/秒返回格式默认为 JSON也可通过formattext获取纯文本数据池约 370 条以响应中的total_pool为准会动态更新调用方需要清楚这是一个轻量、无状态的接口不保证每次返回不同句子如果连续请求频率超过 20 QPS会被限流HTTP 429。另外接口不支持自定义池子或分类过滤。鉴权与参数鉴权方式需要在 HTTP 请求头中携带X-API-Key值为你的密钥。密钥获取方式以平台文档为准。Query 参数参数名必填类型默认值可选值说明format否stringjsonjson / text指定返回格式。text时直接返回纯文本字符串没有外层 JSON。curl 示例可复制以下命令演示携带 API Key 获取 JSON 格式的一言curl -sS \ -X GET \ -H X-API-Key: YOUR_API_KEY_HERE \ https://v1.apizero.cn/api/yiyan?formatjson如果希望纯文本改为curl -sS \ -X GET \ -H X-API-Key: YOUR_API_KEY_HERE \ https://v1.apizero.cn/api/yiyan?formattext注意请将YOUR_API_KEY_HERE替换为真实的 API Key。不要在公开仓库中硬编码密钥。返回值解读JSON 格式 (formatjson)成功响应示例{ code: 0, data: { content: 落霞与孤鹜齐飞秋水共长天一色。, length: 16, total_pool: 370 }, msg: 成功 }字段说明code业务状态码0 表示成功。非 0 表示异常详见错误列表。data.content随机句子字符串。data.length句子字符数汉字计数。data.total_pool当前数据池总句子数可用于监控池更新。msg状态描述。纯文本格式 (formattext)直接返回句子文本例如落霞与孤鹜齐飞秋水共长天一色。无额外包裹无换行符除末尾。注意此时 HTTP 状态码仍遵循 HTTP 规范但业务错误会导致返回非 200 状态码。常见错误与排查下面是调用中最容易遇到的几类错误按照 HTTP 状态码分类。1. 400 Bad Request —— 参数错误现象HTTP/1.1 400 Bad Request {code:1,msg:参数错误}可能原因传入了不支持的format值如formatxml。请求行格式异常如 URL 编码问题。诊断确认只使用json或text。检查 URL 是否包含多余空格或无效字符。修复# 正确示例 curl -sS -H X-API-Key: xxx https://v1.apizero.cn/api/yiyan?formatjson2. 403 Forbidden —— 鉴权失败现象HTTP/1.1 403 Forbidden {code:-1,msg:鉴权失败}原因未携带X-API-Key头。API Key 错误、过期或被吊销。IP 白名单限制如果平台启用。诊断检查请求头中是否包含X-API-Key。使用-v查看详细curl -v -sS -H X-API-Key: xxx https://v1.apizero.cn/api/yiyan验证 API Key 字符串是否完整复制注意前后空格。修复重新生成密钥并正确配置在环境变量中。如果使用了代理确认代理未篡改请求头。3. 429 Too Many Requests —— 限流现象HTTP/1.1 429 Too Many Requests {code:-3,msg:请求过于频繁请稍后再试}原因短时间内请求超过 20 次/秒。并发请求数超过接口允许总 QPS 20。诊断在短时间内手动连续执行 curl 测试观察返回。检查代码中是否未加节流如 for 循环中无 sleep。修复在应用层加入限速每 50ms 最多发一次请求或使用令牌桶。对于批量获取场景如启动时预取多条改用一次请求后本地缓存池拉取多条数据但接口一次只返回一句暂无批量接口。合理做法是降低请求频率或每次间隔 ≥100ms。使用Retry-After响应头如果返回的数值来等待。4. 500 Internal Server Error —— 服务端异常现象HTTP/1.1 500 Internal Server Error {code:-2,msg:服务器内部错误}原因多数时候是服务端临时问题如数据库连接波动、池未加载。诊断等待几秒后重试看是否恢复。检查网络链路DNS 解析、中间代理。确认使用的是正确的域名v1.apizero.cn非apizero.cn二次跳转。修复加入指数退避重试第一次等待1秒第二次2秒第三次4秒……最长等待30秒。如果持续 500联系 API 提供方。5. timeout / 连接拒绝 —— 网络问题现象curl: (28) Connection timed out after XXXX milliseconds curl: (7) Failed to connect to v1.apizero.cn port 443: Connection refused原因本地网络不通公司内网防火墙、代理拦截。DNS 解析失败。接口服务宕机概率低。诊断使用ping v1.apizero.cn检查网络可达性。使用curl -v --connect-timeout 10 https://v1.apizero.cn/api/yiyan观察连接阶段。检查是否被本地 HTTPS 证书拦截加-k仅用于测试生产环境不应忽略证书。修复调整防火墙规则放行443端口。配置正确代理--proxy参数。如果使用 HTTP 而非 HTTPS请求应使用 HTTPS接口强制 TLS。工程化注意事项密钥管理不要将密钥硬编码在代码中。建议通过环境变量APIZERO_API_KEY注入生产环境使用密钥管理服务。日志记录在每次 API 调用前后打印请求标识、耗时和响应状态码方便事后排查。重试策略对于 429 和 5xx 错误实现有限次数的重试如 3 次间隔递增。对 4xx除 429不要重试因为修改请求才是根本。错误分类在代码中区分“可重试”和“不可重试”错误。例如可重试429、500、网络超时。不可重试400、403需人工干预。响应解析容错即使formatjson也要处理偶发的非 JSON 响应如网关返回 HTML。使用 try-catch 包裹 JSON 解析。资源释放HTTP 客户端需正确关闭连接、设置超时。避免连接泄漏导致程序挂起。参考文档一言简版API 文档https://apizero.cn/aidocs/yiyan原始文档需准备查看https://apizero.cn/aidocs/yiyan/raw.md
适用场景一言简版API 返回随机的中文句子适合在站点页脚、小程序欢迎语、控制台启动提示或任何需要“一句话点缀”的场景中嵌入。本指南面向已经或准备使用该接口的开发者重点解决接入过程中最容易遇到的故障而非介绍功能本身。接口能力边界请求方法GET地址https://v1.apizero.cn/api/yiyanQPS每秒请求配额20 次/秒返回格式默认为 JSON也可通过formattext获取纯文本数据池约 370 条以响应中的total_pool为准会动态更新调用方需要清楚这是一个轻量、无状态的接口不保证每次返回不同句子如果连续请求频率超过 20 QPS会被限流HTTP 429。另外接口不支持自定义池子或分类过滤。鉴权与参数鉴权方式需要在 HTTP 请求头中携带X-API-Key值为你的密钥。密钥获取方式以平台文档为准。Query 参数参数名必填类型默认值可选值说明format否stringjsonjson / text指定返回格式。text时直接返回纯文本字符串没有外层 JSON。curl 示例可复制以下命令演示携带 API Key 获取 JSON 格式的一言curl -sS \ -X GET \ -H X-API-Key: YOUR_API_KEY_HERE \ https://v1.apizero.cn/api/yiyan?formatjson如果希望纯文本改为curl -sS \ -X GET \ -H X-API-Key: YOUR_API_KEY_HERE \ https://v1.apizero.cn/api/yiyan?formattext注意请将YOUR_API_KEY_HERE替换为真实的 API Key。不要在公开仓库中硬编码密钥。返回值解读JSON 格式 (formatjson)成功响应示例{ code: 0, data: { content: 落霞与孤鹜齐飞秋水共长天一色。, length: 16, total_pool: 370 }, msg: 成功 }字段说明code业务状态码0 表示成功。非 0 表示异常详见错误列表。data.content随机句子字符串。data.length句子字符数汉字计数。data.total_pool当前数据池总句子数可用于监控池更新。msg状态描述。纯文本格式 (formattext)直接返回句子文本例如落霞与孤鹜齐飞秋水共长天一色。无额外包裹无换行符除末尾。注意此时 HTTP 状态码仍遵循 HTTP 规范但业务错误会导致返回非 200 状态码。常见错误与排查下面是调用中最容易遇到的几类错误按照 HTTP 状态码分类。1. 400 Bad Request —— 参数错误现象HTTP/1.1 400 Bad Request {code:1,msg:参数错误}可能原因传入了不支持的format值如formatxml。请求行格式异常如 URL 编码问题。诊断确认只使用json或text。检查 URL 是否包含多余空格或无效字符。修复# 正确示例 curl -sS -H X-API-Key: xxx https://v1.apizero.cn/api/yiyan?formatjson2. 403 Forbidden —— 鉴权失败现象HTTP/1.1 403 Forbidden {code:-1,msg:鉴权失败}原因未携带X-API-Key头。API Key 错误、过期或被吊销。IP 白名单限制如果平台启用。诊断检查请求头中是否包含X-API-Key。使用-v查看详细curl -v -sS -H X-API-Key: xxx https://v1.apizero.cn/api/yiyan验证 API Key 字符串是否完整复制注意前后空格。修复重新生成密钥并正确配置在环境变量中。如果使用了代理确认代理未篡改请求头。3. 429 Too Many Requests —— 限流现象HTTP/1.1 429 Too Many Requests {code:-3,msg:请求过于频繁请稍后再试}原因短时间内请求超过 20 次/秒。并发请求数超过接口允许总 QPS 20。诊断在短时间内手动连续执行 curl 测试观察返回。检查代码中是否未加节流如 for 循环中无 sleep。修复在应用层加入限速每 50ms 最多发一次请求或使用令牌桶。对于批量获取场景如启动时预取多条改用一次请求后本地缓存池拉取多条数据但接口一次只返回一句暂无批量接口。合理做法是降低请求频率或每次间隔 ≥100ms。使用Retry-After响应头如果返回的数值来等待。4. 500 Internal Server Error —— 服务端异常现象HTTP/1.1 500 Internal Server Error {code:-2,msg:服务器内部错误}原因多数时候是服务端临时问题如数据库连接波动、池未加载。诊断等待几秒后重试看是否恢复。检查网络链路DNS 解析、中间代理。确认使用的是正确的域名v1.apizero.cn非apizero.cn二次跳转。修复加入指数退避重试第一次等待1秒第二次2秒第三次4秒……最长等待30秒。如果持续 500联系 API 提供方。5. timeout / 连接拒绝 —— 网络问题现象curl: (28) Connection timed out after XXXX milliseconds curl: (7) Failed to connect to v1.apizero.cn port 443: Connection refused原因本地网络不通公司内网防火墙、代理拦截。DNS 解析失败。接口服务宕机概率低。诊断使用ping v1.apizero.cn检查网络可达性。使用curl -v --connect-timeout 10 https://v1.apizero.cn/api/yiyan观察连接阶段。检查是否被本地 HTTPS 证书拦截加-k仅用于测试生产环境不应忽略证书。修复调整防火墙规则放行443端口。配置正确代理--proxy参数。如果使用 HTTP 而非 HTTPS请求应使用 HTTPS接口强制 TLS。工程化注意事项密钥管理不要将密钥硬编码在代码中。建议通过环境变量APIZERO_API_KEY注入生产环境使用密钥管理服务。日志记录在每次 API 调用前后打印请求标识、耗时和响应状态码方便事后排查。重试策略对于 429 和 5xx 错误实现有限次数的重试如 3 次间隔递增。对 4xx除 429不要重试因为修改请求才是根本。错误分类在代码中区分“可重试”和“不可重试”错误。例如可重试429、500、网络超时。不可重试400、403需人工干预。响应解析容错即使formatjson也要处理偶发的非 JSON 响应如网关返回 HTML。使用 try-catch 包裹 JSON 解析。资源释放HTTP 客户端需正确关闭连接、设置超时。避免连接泄漏导致程序挂起。参考文档一言简版API 文档https://apizero.cn/aidocs/yiyan原始文档需准备查看https://apizero.cn/aidocs/yiyan/raw.md
