跳到主要内容

API 参考

成员 API
成员 API的直接链接

以下端点的根 URL 为:/v1/org/members

方法端点描述
GET/列出成员
POST/invitations发送邀请
GET/invitations列出邀请
DELETE/invitations/:id撤销邀请
PATCH/:id更新成员角色
DELETE/:id移除成员

API token
API token的直接链接

以下端点的根 URL 为:/v1/auth/tokens

方法端点描述
POST/创建 API token
GET/列出 API token
DELETE/:id删除 API token

Studio API
Studio API的直接链接

以下端点的根 URL 为:/v1/studio

方法端点描述
GET/projects列出 Studio 项目
POST/projects创建项目
GET/projects/:id获取项目详情和部署记录
DELETE/projects/:id删除项目
POST/deploys创建部署
POST/deploys/:id/upload-complete确认制品上传完成
GET/deploys/:id获取部署状态
GET/deploys/:id/logs获取部署日志
GET/deploys/:id/logs/stream流式传输部署日志(SSE)

Server API
Server API的直接链接

以下端点的根 URL 为:/v1/server

方法端点描述
GET/projects列出 server 项目
POST/projects创建项目
GET/projects/:id获取项目详情
DELETE/projects/:id删除项目
PUT/projects/:id/env设置环境变量
GET/projects/:id/env获取环境变量
POST/projects/:id/env/restart环境变量变更后重启
GET/projects/:id/domains列出域名
POST/projects/:id/domains添加自定义域名
GET/projects/:id/runtime-logs获取运行时日志
POST/projects/:id/redeploy触发重新部署
POST/projects/:id/always-on启用 always-on
DELETE/projects/:id/always-on禁用 always-on
POST/deploys创建部署
POST/deploys/:id/upload-complete确认制品上传完成
GET/deploys/:id获取部署状态
GET/deploys/:id/logs获取部署日志
POST/deploys/:id/cancel取消排队中或进行中的部署
DELETE/deploys/:id停止运行中的部署

Gateway API
Gateway API的直接链接

以下端点的根 URL 为:/v1/gateway

方法端点描述
GET/projects列出 Gateway 项目
GET/projects/:id获取项目详情
PATCH/projects/:id更新项目设置
DELETE/projects/:id删除项目
POST/projects/provision配置新的 Gateway 项目
GET/projects/:id/keys列出 API key
POST/projects/:id/keys创建 API key
DELETE/projects/:id/keys/:keyId撤销 API key
GET/projects/:id/keys/:keyId/bindings列出 key 级 Provider 绑定
POST/projects/:id/keys/:keyId/bindings添加 key 级 Provider 绑定(BYOK)
DELETE/projects/:id/keys/:keyId/bindings/:provider移除 key 级绑定
GET/projects/:id/bindings列出项目级 Provider 绑定
POST/projects/:id/bindings添加项目级 Provider 绑定(BYOK)
DELETE/projects/:id/bindings/:provider移除项目级绑定
GET/projects/:id/usage/has-activity检查项目是否收到过请求
GET/projects/:id/usage/activity获取汇总的用量活动
GET/projects/:id/usage/memory-activity获取某一时间范围内的 memory token 总数
GET/projects/:id/usage/logs获取请求日志
GET/projects/:id/usage/logs/facets获取日志筛选分面
GET/projects/:id/usage/logs/:requestId获取指定请求的详情
GET/projects/:id/memory/threads列出 thread(dashboard)
POST/projects/:id/memory/threads创建 thread(dashboard)
GET/projects/:id/memory/threads/:threadId获取 thread(dashboard)
PATCH/projects/:id/memory/threads/:threadId更新 thread(dashboard)
DELETE/projects/:id/memory/threads/:threadId删除 thread(dashboard)
POST/projects/:id/memory/threads/:threadId/clone克隆 thread(dashboard)
GET/projects/:id/memory/threads/:threadId/messages列出消息(dashboard)
POST/projects/:id/memory/threads/:threadId/messages保存消息(dashboard)
DELETE/projects/:id/memory/threads/:threadId/messages删除消息(dashboard)
GET/projects/:id/memory/threads/:threadId/observations/history观察历史记录(dashboard)
GET/models列出可用模型

Gateway 代理端点
Gateway 代理端点的直接链接

有关更多详情,请参阅 Gateway 文档