开发者中心

API 参考文档 · 代码示例 · 快速集成指南

API 密钥

Code Sandbox

Model Playground

Agent 监控

API 端点参考

对话 & Agent

6 端点

POST/api/chat/send发送对话消息，返回 AI 回复

GET/api/chat/agents获取我的 Agent 列表

GET/api/chat/agents/:id获取单个 Agent 详情

POST/api/chat/agents创建新 Agent

PATCH/api/chat/agents/:id更新 Agent 配置

DELETE/api/chat/agents/:id删除 Agent

知识库 & RAG

5 端点

GET/api/knowledge-base获取知识库列表

POST/api/knowledge-base创建知识库

DELETE/api/knowledge-base/:id删除知识库

POST/api/knowledge-base/:id/documents添加文档到知识库

GET/api/knowledge-base/:id/search语义搜索知识库

工作流 & 定时任务

6 端点

GET/api/workflow获取工作流列表

POST/api/workflow创建工作流

PATCH/api/workflow/:id更新工作流

DELETE/api/workflow/:id删除工作流

GET/api/schedule获取定时任务列表

POST/api/schedule创建定时任务

用户 & 认证

4 端点

GET/api/users/me获取当前用户信息

GET/api/users/usage获取用量统计

GET/api/users/quota获取配额信息

POST/api/auth/refresh刷新登录凭证

模型 & API 密钥

5 端点

GET/api/models/list获取可用模型目录

GET/api/models/availability查询模型可用性

GET/api/api-keys获取 API 密钥列表

POST/api/api-keys添加 API 密钥

DELETE/api/api-keys/:id删除 API 密钥

短剧 Open API

企业版8 端点

GET/api/v1/drama/drafts分页列出短剧草稿（企业版）

POST/api/v1/drama/drafts创建草稿 { title, genre? }

GET/api/v1/drama/drafts/:id获取草稿与分镜摘要

PUT/api/v1/drama/drafts/:id更新分镜 scenes[]

POST/api/v1/drama/drafts/:id/video单镜试看 { sceneIndex, provider? }

GET/api/v1/drama/video/jobs/:jobId轮询视频任务状态

POST/api/v1/drama/drafts/:id/script从 prompt 生成脚本并写入草稿

POST/api/drama/open-api-keys创建平台密钥（JWT 登录，一次性返回 zxai_...）

短剧 Open API需升级企业版 · 升级后解锁查看接入说明

沙箱 & 运行监控

4 端点

POST/api/agent-runtime/runs/code-exec执行沙箱 JavaScript 代码

GET/api/agent-runtime/runs获取 Agent 运行记录

POST/api/agent-runtime/runs/:id/approve通过 Agent 工具审批

POST/api/agent-runtime/runs/:id/reject拒绝 Agent 工具审批

短剧 Open API 密钥

企业版

调用 /api/v1/drama/* 需使用 zxai_ 平台密钥（Bearer 鉴权）。

短剧 Open API需升级企业版 · 升级后解锁

代码示例

# 发送对话消息
curl -X POST https://zhiflow.com/api/chat/send \
  -H "Content-Type: application/json" \
  -H "Cookie: zhiflow_token=YOUR_TOKEN" \
  -d '{
    "message": "你好，请介绍一下自己",
    "model": "deepseek-chat"
  }'

# 短剧 Open API（企业版，Bearer zxai_ 平台密钥）
curl https://zhiflow.com/api/v1/drama/drafts \
  -H "Authorization: Bearer zxai_YOUR_KEY"

curl -X POST https://zhiflow.com/api/v1/drama/drafts \
  -H "Authorization: Bearer zxai_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"霸总追妻","genre":"都市逆袭"}'

curl -X POST https://zhiflow.com/api/v1/drama/drafts/DRAFT_ID/video \
  -H "Authorization: Bearer zxai_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sceneIndex":1,"provider":"auto"}'

# 获取知识库列表
curl https://zhiflow.com/api/knowledge-base \
  -H "Cookie: zhiflow_token=YOUR_TOKEN"

# 执行 JavaScript 代码
curl -X POST https://zhiflow.com/api/agent-runtime/runs/code-exec \
  -H "Content-Type: application/json" \
  -H "Cookie: zhiflow_token=YOUR_TOKEN" \
  -d '{
    "language": "javascript",
    "code": "console.log(2 + 2)",
    "timeoutMs": 5000
  }'

集成指南

获取 API 密钥

在设置 → API 密钥中添加第三方服务的 API Key（OpenAI、DeepSeek 等），Agent 将自动使用。

创建 Agent

通过 Agent 构建器定义角色、工具集和知识源，或从模板市场一键安装。

开始对话

在对话页面选择 Agent，发送消息即可。Agent 会自动调用工具、搜索知识库。

私有化部署包

OEM 内网版：api + web + postgres + redis · deploy-private.sh 一键拉起

免费额度

新用户注册即获赠算力额度，无需绑定支付方式即可体验全部功能。

API 状态

所有 API 服务运行正常 · 平均响应时间 <2s · 99.9% 可用性