开放 API 概览
将多人格 AI 观众心智测评能力集成进你的内容生产流水线
接入信息
Base URLhttps://api.veda-ai.com
API 版本v1(路径前缀 /v1)
协议HTTPS / JSON
字符编码UTF-8
限流默认 20 QPS / 客户(可在后台调整)
统一响应体
所有接口返回结构一致,便于客户端统一解析:
| 字段 | 类型 | 说明 |
|---|---|---|
| code | int | 业务状态码,成功固定为 200 |
| message | string | 状态描述,成功为 success |
| data | object | null | 业务数据负载,失败时通常为 null |
| requestId | string | 全链路追踪 ID,排障时请提供 |
快速开始
1. 在「用户端」用 Bearer Token 提交一次评估任务 →
2. 用返回 taskId 轮询 GET /v1/eval/{taskId} 获取结果 →
3. 或配置 Webhook,任务完成时由服务端主动回调通知。
前往鉴权 →
查看端点 →
下载 SDK →
鉴权方式
两套鉴权体系:用户端简单 Bearer,开放端防重放签名
① 用户端 · Bearer Token
适合服务端直连 / 内部调用在 Authorization 头携带用户令牌,简单易用,令牌与账号绑定,泄露即失窃。
② 开放端 · APIKey + Secret + 时间戳防重放
适合第三方开放集成使用 APIKey 标识身份、Secret 参与签名,Timestamp 与时间窗口(±300s)防重放,Nonce 防复用。签名算法:HMAC-SHA256(Secret, APIKey+Timestamp+Nonce+Body)。
Secret 仅用于本地签名,切勿在网络中明文传输或写入前端代码。
API 端点
点击端点展开请求 / 响应示例与错误码(支持 JS / Python / cURL 切换)
业务错误码
错误码为 6 位整数,携带于响应体 code 字段与 message
| 错误码 | 含义 | HTTP | 建议处理 |
|---|
SDK 下载
官方多语言 SDK,内置鉴权、重试与签名
🟨
JavaScript / TS
v1.2.0 · Node 18+ / 浏览器
🐍
Python
v1.1.4 · Python 3.9+
🐹
Go
v1.0.2 · Go 1.21+
安装示例
npm i @veda-ai/eval-sdk # 或 pip install veda-eval-sdk
SDK 已封装幂等键生成、开放端签名与时间戳防重放,开箱即用。