Skip to content

API 参考概述

Talon Sandbox 提供 REST HTTP API,所有端点均以 /v1/ 为前缀。

基础 URL

http(s)://<your-host>:18080

认证方式

支持两种认证方式:

1. Bearer Token(API Key)

适合 agent、脚本、服务端调用:

http
Authorization: Bearer ask_X_your_api_key_here

适合 Web 控制台(浏览器):

先调用 POST /v1/auth/login 获取 session cookie,后续请求自动携带。

响应格式

所有成功响应返回 JSON,Content-Type 为 application/json

错误响应统一格式:

json
{
  "error": "描述错误的字符串"
}

HTTP 状态码含义:

状态码含义
200成功
201资源创建成功
204成功,无响应体
400请求参数错误
401未认证
403权限不足(角色不满足)
404资源不存在
409状态冲突(如非法状态转换)
412前置条件不满足(如 chromium 未安装)
429超过速率限制
503服务不可用(依赖未注入)

角色与权限

租户内有三个角色:

角色可执行操作
viewer所有 GET 只读操作
developer所有 GET + 创建/修改 sandbox、process、secrets 等写操作
owner所有操作 + 管理其他用户的角色

端点列表

分组端点
认证登录、登出、当前用户、API Key 管理
SandboxesCRUD + start/stop/pause/resume/exec
Processes启动/停止长驻进程 + 日志
PTYWebSocket 交互式终端 + 录像
文件系统读/写/列/删 workspace 文件
Browser启动 Chromium + CDP URL
Agent Run高层 agent.run 接口
Admin / Secrets / Audit管理员操作、secrets 管理、审计日志
错误码错误信息对照表

速率限制

登录端点有滑动窗口速率限制(防暴力破解)。其他端点目前无速率限制,未来版本会加。

基于 MIT License 发布