跳到主要内容
Developers · 开放 APIOpenAPI 3.1

开发者文档
用代码调用一支 AI 运营团队

通过 REST API 以编程方式调用智能运营能力。密钥鉴权、限流配额、内容生成,全部可程序化接入。

机读规范: /api/v1/openapi.json (可导入 Postman / Apifox / editor.swagger.io)

去后台创建 API 密钥 →下载 OpenAPI Spec

国内 only · 数据驻留中国境内

Authentication

鉴权与基地址

在客户后台创建密钥,以 Bearer Token 调用。所有请求统一响应结构。

鉴权

在「客户后台 → API 密钥」创建密钥,请求头携带:

Authorization: Bearer saio_live_xxxxxxxxxxxx
  • 限流与月度配额按订阅档位;响应头含 X-RateLimit-Limit / -Remaining / -Reset。
  • 超限返回 429;密钥无效 401;范围不足 403。
  • 统一响应:成功 { ok: true, data },失败 { ok: false, error, code }。

Base URL

所有端点路径均相对此基地址拼接:

https://api.aizhongzhu.com/api/v1
查看完整机读规范

Endpoints

端点

以下端点由 OpenAPI 规范自动生成,始终与线上接口一致。

GET/health公开

健康检查

响应

  • 200 — 服务正常
curl -X GET "https://api.aizhongzhu.com/api/v1/health"
GET/me

当前密钥所属账户

响应

  • 200 — 账户信息
  • 401 — 密钥无效
curl -X GET "https://api.aizhongzhu.com/api/v1/me" \
  -H "Authorization: Bearer $SAIO_API_KEY"
GET/usage

当前用量与配额

响应

  • 200 — 用量
  • 401 — 密钥无效
curl -X GET "https://api.aizhongzhu.com/api/v1/usage" \
  -H "Authorization: Bearer $SAIO_API_KEY"
GET/export/business

导出账户业务/分析数据

程序化拉取本密钥所属账户(租户)级业务+分析数据。需套餐 `data_export ∈ {csv_api, api_custom}`(Pro Max / Enterprise);JSON 仅 Enterprise(api_custom)。

查询参数

  • format (string)

响应

  • 200 — 导出数据(format=csv → text/csv;format=json → application/json)
  • 401 — 密钥无效
  • 403 — 套餐不支持 API 导出 / 该格式
  • 422 — format 参数错误
  • 429 — 超出限流或月度配额
curl -X GET "https://api.aizhongzhu.com/api/v1/export/business" \
  -H "Authorization: Bearer $SAIO_API_KEY"
GET/content/drafts

列出内容草稿

需 `content:read` 范围。

查询参数

  • limit (integer)

响应

  • 200 — 草稿列表
  • 401 — 密钥无效
  • 403 — 缺少 content:read 范围
curl -X GET "https://api.aizhongzhu.com/api/v1/content/drafts" \
  -H "Authorization: Bearer $SAIO_API_KEY"
POST/content/generate

生成内容

调用内容官 Agent 生成多渠道文案,产物自动过广告法合规审查。需 `content:write` 范围。

响应

  • 200 — 生成结果
  • 401 — 密钥无效
  • 403 — 缺少 content:write 范围
  • 422 — 参数错误
  • 429 — 超出限流或月度配额
curl -X POST "https://api.aizhongzhu.com/api/v1/content/generate" \
  -H "Authorization: Bearer $SAIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channel":"xiaohongshu","topic":"新品上市种草"}'

Get Started

拿到密钥,几行 curl 就能跑通

国内 only · 数据存储中国境内 · 接入国内备案大模型。

去后台创建 API 密钥 →看各档位配额