TeamDay API v1 - 概要

TeamDay API により、開発者は TeamDay AI プラットフォームをプログラムで操作できます。シンプルな REST API を通じて、カスタム統合の構築、ワークフローの自動化、AI エージェントの管理を行います。

ベース URL: https://us.teamday.ai/api/v1

現在の状態: 87.5% 動作中 (テスト済みエンドポイントの 8 個中 7 個が動作)


クイックスタート

# 1. Settings → API Access から 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 は以下のリソースグループに整理されています:

リソース説明エンドポイント
認証Personal Access Tokens (PAT)トークン管理
エージェントAI エージェントの作成と管理6 エンドポイント
実行エージェント実行履歴の追跡4 エンドポイント
タスクタスクとワークフローの管理2 エンドポイント
エラーエラーコードと処理リファレンス

認証

すべての API リクエストは、Authorization ヘッダーで渡される Personal Access Token (PAT) が必要です:

Authorization: Bearer td_xxxxx...

トークンを取得する:

  1. TeamDay にログイン
  2. Settings → API Access に移動
  3. Generate New Token をクリック
  4. コピーして安全に保存 (1 回だけ表示されます)

認証についてもっと学ぶ →


コアコンセプト

エージェント

エージェントはカスタマイズ可能なシステムプロンプト、ロール、機能を備えた 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_ - Personal Access Token

可視性

エージェントとリソースは 3 つの可視性レベルをサポートします:

  • private - 作成者のみに表示
  • organization - 組織メンバーに表示
  • public - すべてに表示 (将来)

既知の問題

エージェント実行 (破損)

状態: 🔴 重大な問題

/api/v1/agents/[id]/execute エンドポイントは現在、内部サービスの問題により 500 エラーを返します。修正に積極的に取り組んでいます。

回避策: 解決するまで、エージェント実行にはウェブインターフェースを使用してください。

影響を受けるエンドポイント:

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

問題の状態を追跡 →


API チェンジログ

2025年12月9日

状態:

  • ✅ テスト済みエンドポイントの 7/8 が動作中 (87.5%)
  • 🔴 エージェント実行エンドポイントが一時的に利用不可
  • 🟡 追加エンドポイントはテスト未了 (タスク、実行)

認証:

  • ✅ PAT トークンシステムが完全に動作
  • ✅ SHA-256 ハッシュ検証
  • ✅ AES-256-GCM 保存時暗号化
  • ✅ 自動期限切れ処理 (7~365 日)

エージェント CRUD:

  • ✅ エージェントをリスト表示
  • ✅ エージェントを作成
  • ✅ エージェントの詳細を取得
  • ✅ エージェントを更新
  • ✅ エージェントを削除 (ソフト削除)

サポートとコミュニティ

ドキュメント:

サポートが必要ですか?


次のステップ

  1. 認証を取得 - API トークンを生成
  2. エージェントを作成 - 最初の AI アシスタントを構築
  3. 例を表示 - 実世界のユースケースを確認
  4. ベストプラクティスを学ぶ - 統合を最適化

最後に更新: 2025年12月9日