TeamDay API v1 - 概述

TeamDay API 使开发人员能够以编程方式与 TeamDay AI 平台交互。通过简单的 REST API 构建自定义集成、自动化工作流并管理 AI 代理。

基础 URL： https://us.teamday.ai/api/v1

当前状态： 87.5% 工作（8 个测试端点中有 7 个可操作）

快速开始

# 1. 从设置 → API 访问获取 API 令牌
export TEAMDAY_TOKEN="td_your_token_here"

# 2. 发出第一个请求
curl https://us.teamday.ai/api/v1/agents \
  -H "Authorization: Bearer $TEAMDAY_TOKEN"

API 组

TeamDay v1 API 组织为以下资源组：

资源	描述	端点
身份验证	个人访问令牌 (PAT)	令牌管理
代理	创建和管理 AI 代理	6 个端点
执行	跟踪代理执行历史	4 个端点
任务	管理任务和工作流	2 个端点
错误	错误代码和处理	参考

身份验证

所有 API 请求都需要在 Authorization 标头中传递个人访问令牌 (PAT)：

Authorization: Bearer td_xxxxx...

获取令牌：

登录到 TeamDay
导航至设置 → API 访问
点击生成新令牌
复制并安全存储（仅显示一次）

了解有关身份验证的更多信息 →

核心概念

代理

代理是具有可自定义系统提示、角色和功能的 AI 助手。创建代理来自动化任务、分析数据或协助工作流。

示例：

# 创建新代理
curl -X POST https://us.teamday.ai/api/v1/agents \
  -H "Authorization: Bearer $TEAMDAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Research Assistant",
    "role": "Research and analysis",
    "systemPrompt": "You are a research assistant...",
    "visibility": "private"
  }'

查看完整的代理文档 →

执行

执行跟踪代理的运行时间。每次执行都捕获消息、工具使用和结果的完整历史。

示例：

# 列出最近的执行
curl https://us.teamday.ai/api/v1/executions?limit=10 \
  -H "Authorization: Bearer $TEAMDAY_TOKEN"

查看完整的执行文档 →

任务

任务表示分配给代理或用户的工作项。任务可以按状态、受让人和工作区筛选。

示例：

# 列出待处理任务
curl https://us.teamday.ai/api/v1/tasks?status=pending \
  -H "Authorization: Bearer $TEAMDAY_TOKEN"

查看完整的任务文档 →

响应格式

所有响应都遵循一致的 JSON 结构：

成功响应

{
  "id": "agent_123",
  "name": "Research Assistant",
  "createdAt": "2025-12-09T12:00:00Z",
  "...": "..."
}

错误响应

{
  "error": true,
  "statusCode": 400,
  "statusMessage": "Bad Request",
  "message": "Missing required field: name"
}

查看错误参考 →

速率限制

当前，API 不强制执行速率限制。这可能在将来改变。最佳实践：

使用合理的请求速率
为重试实现指数退避
在适当时缓存响应
考虑 webhook 以获取实时更新（即将推出）

分页

列表端点通过查询参数支持分页：

# 获取 50 个结果（默认限制）
curl https://us.teamday.ai/api/v1/executions \
  -H "Authorization: Bearer $TEAMDAY_TOKEN"

# 指定自定义限制
curl https://us.teamday.ai/api/v1/executions?limit=100 \
  -H "Authorization: Bearer $TEAMDAY_TOKEN"

参数：

limit - 每个请求的最大结果数（默认值：50）

筛选

大多数列表端点都支持通过查询参数进行筛选：

# 按代理筛选执行
curl "https://us.teamday.ai/api/v1/executions?agentId=agent_123" \
  -H "Authorization: Bearer $TEAMDAY_TOKEN"

# 按状态和空间筛选任务
curl "https://us.teamday.ai/api/v1/tasks?status=pending&spaceId=space_456" \
  -H "Authorization: Bearer $TEAMDAY_TOKEN"

有关可用筛选器，请参阅单个端点文档。

数据类型

时间戳

所有时间戳都是 UTC 中的 ISO 8601 字符串：

{
  "createdAt": "2025-12-09T12:00:00Z",
  "updatedAt": "2025-12-09T14:30:00Z"
}

ID

资源使用带有类型安全前缀的字符串 ID：

agent_ - 代理 ID
exec_ - 执行 ID
task_ - 任务 ID
space_ - 空间 ID
org_ - 组织 ID
td_ - 个人访问令牌

可见性

代理和资源支持三个可见性级别：

private - 仅对创建者可见
organization - 对组织成员可见
public - 对所有人可见（未来）

已知问题

代理执行（损坏）

状态： 🔴 关键问题

/api/v1/agents/[id]/execute 端点由于内部服务问题目前返回 500 错误。我们正在积极研究解决方案。

解决方案： 在解决前使用 web 界面进行代理执行。

受影响的端点：

POST /api/v1/agents/[id]/execute

跟踪问题状态 →

支持和社区

文档：

需要帮助吗？

📧 电子邮件：support at teamday.ai
💬 Discord：加入社区
🐛 问题：GitHub

下一步

获取身份验证 - 生成您的 API 令牌
创建代理 - 构建您的第一个 AI 助手
查看示例 - 查看真实用例
学习最佳实践 - 优化您的集成

最后更新： 2025 年 12 月 9 日