跳到主要内容

本地 API 概览

TikMatrix 提供了一个本地的 RESTful API，允许你以编程方式管理任务。这对于将 TikMatrix 集成到你自己的自动化系统、构建自定义工作流程或创建批量操作非常有用。

要求​

许可证要求

本地 API 仅对 Pro、Team 和 Business 计划用户开放。 Starter 计划不提供 API 访问权限。

基础 URL​

API 在本机运行，地址为：

http://localhost:50809/api/v1/
备注

端口 50809 为默认端口。请在发起请求前确保 TikMatrix 已在运行。

响应格式​

所有 API 响应遵循以下格式：

{
  "code": 0,
  "message": "success",
  "data": { ... }
}

响应码说明​

Code描述
0成功
40001参数错误 - 无效的请求参数
40002参数错误 - 缺少 script_name
40003参数错误 - 脚本暂不支持 API 调用
40301禁止 - API 访问需要 Pro+ 计划
40401未找到 - 资源不存在
50001服务器内部错误

快速开始​

1. 检查 API 访问权限​

首先，确认你的许可证是否支持 API：

curl http://localhost:50809/api/v1/license/check

示例响应：

{
  "code": 0,
  "message": "success",
  "data": {
    "plan_name": "Pro",
    "api_enabled": true,
    "device_limit": 20,
    "message": "API access enabled"
  }
}

2. 创建任务​

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1", "device_serial_2"],
    "script_name": "post",
    "script_config": {
      "content_type": 1,
      "captions": "看看我的新视频！#热门"
    },
    "enable_multi_account": false
  }'

3. 查询任务列表​

curl http://localhost:50809/api/v1/task?status=0&page=1&page_size=20

可用脚本​

当前支持

目前，本地 API 支持 post、follow、unfollow、account_warmup 和 comment 脚本。更多脚本将在未来版本中陆续添加。

script_name 参数可接受下列值：

脚本名描述API 支持
post发布内容✅ 已支持
follow关注用户✅ 已支持
unfollow取消关注✅ 已支持
account_warmup账号预热✅ 已支持
comment评论✅ 已支持
like点赞🔜 即将推出
message私信🔜 即将推出
super_marketing超级营销活动🔜 即将推出
profile更新个人资料🔜 即将推出
scrape_user抓取用户数据🔜 即将推出

任务状态​

状态码状态文本描述
0pending任务等待执行
1running任务正在执行
2completed任务执行成功
3failed任务执行失败

后续​