接口简介
「AI Token 计数」(ai-token)是数据鱼API平台提供的面向主流大模型的 Token 数量近似估算接口,Base 路径 /api/ai-token,共 3 个端点。内置启发式引擎(heuristic-local),按模型族采用不同的字符换算比例:GPT 系英文约 4 字符折 1 Token、中文约 0.6 字符折 1 Token;Claude 系英文约 3.5 字符、中文约 0.7 字符。输入文本与目标模型,返回 Token 估算值与构成明细(中文字符数、英文单词数、其他字符数)。
它解决的是「拿不到厂商分词器时的估算」问题:在客户端、CI 环境或无法引入厂商 SDK 的场景里,快速得到量级正确的 Token 数,用于上下文窗口预算、用量预估与费用提示。接口不联网、不依赖任何模型服务,响应为纯本地计算结果。
接口包含三个端点:免鉴权健康检查(同时返回引擎与支持模型列表)、换算比例口径查询、Token 计数。
端点总览
方法 路径 说明 鉴权
GET /api/ai-token/ping 健康检查(免鉴权),返回引擎与支持模型 免鉴权
GET /api/ai-token/stats 各模型族字符换算比例口径 需要
POST /api/ai-token/count Token 计数与构成明细 需要
通用约定
鉴权使用 X-API-Key 请求头或 ?api_key= 查询参数,全站统一 Key:缺失返回 4011,无效返回 4013。响应为统一三段结构 {code, msg, data},code 为 0 表示成功。参数类错误 4001~4004 分别对应缺少必填参数、格式或取值非法、取值不在支持列表、目标未收录;4040 为路由不存在,4050 为方法不允许,5000/5001 为服务内部错误。POST 支持 JSON body 或表单,参数名与 query 完全一致。以上为数据鱼API平台全站通用约定。
核心端点详解
Token 计数(POST /count)
用途:对给定文本按目标模型口径估算 Token 数量。
参数 类型 必填 默认 说明
text array/object 否 — 待计数的文本(类型标注见注意事项)
model array/object 否 — 目标模型(类型标注见注意事项)
返回字段要点:text_length 为文本长度;model 为实际采用的口径标识,缺省返回 basic;tokens 为估算 Token 数;breakdown 为构成明细,含 chinese_chars(中文字符数)、english_words(英文单词数)、others(其他字符数)。
请求示例:
POST /api/ai-token/count?api_key=YOUR_KEY
Content-Type: application/json
{"text": "hello world"}
响应示例(字段结构以文档实测输出为准,数值随输入变化):
{
"code": 0,
"msg": "success",
"data": {
"text_length": 11,
"model": "basic",
"tokens": 4,
"breakdown": {
"chinese_chars": 0,
"english_words": 2,
"others": 1
}
}
}
换算口径(GET /stats)
无请求参数。返回各模型族的字符换算比例:gpt_ratio(英文 1 Token 约合 4 字符、中文约合 0.6 字符)、claude_ratio(英文约 3.5 字符、中文约 0.7 字符)。该口径可直接用于客户端本地预估,减少对 count 端点的调用频次。
GET /api/ai-token/stats?api_key=YOUR_KEY
健康检查(GET /ping)
免鉴权,无请求参数。除版本信息外,返回 engine(heuristic-local)与 supported_models 列表(gpt-3.5-turbo、gpt-4、claude-2、claude-3-opus),是确认当前支持模型范围的最快途径。
GET /api/ai-token/ping
数据与限制
支持模型以 ping 返回的列表为准;列表外的模型建议使用缺省 basic 口径。
估算为启发式近似,与厂商 tokenizer 的精确结果存在偏差,文档未给出误差承诺。
换算比例基于字符数,对代码、混合语言、表情符号密集的文本误差更大。
纯本地计算,无缓存 TTL 与上游依赖问题。
典型使用场景
对话输入框实时提示「预计消耗 Token 数」,做上下文窗口预算。
批处理任务发送前批量预估文本 Token 量,安排分片与配额。
客户端按 stats 比例本地换算,做费用提示而无需逐次请求计数。
注意事项
文档参数表把 text 与 model 的类型标注为「数组/对象」,与参数语义(待处理文本、模型名)不符,属文档口径问题;建议按字符串传参并以实测为准。
model 缺省时按 basic 口径返回通用近似值,不区分模型族比例。
中英文换算比例差异明显,含中文的文本不要套用英文比例手工折算,直接调用 count 或按 stats 的中文口径处理。
本接口属于数据鱼API平台开发工具类接口,鉴权与错误码处理方式与其他接口一致。