メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.qoder.com/llms.txt

Use this file to discover all available pages before exploring further.

Agent は Qoder Cloud Agents の中核となる構成テンプレートで、AI エージェントの能力範囲(モデル・行動指針・利用ツール)を定義します。1 つの Agent は複数の Session で再利用でき、Agent の更新が稼働中の Session に影響することはありません。

コア要素

Agent は「職務記述書」のようなものです。
要素役割
モデルAgent の推論能力
システムプロンプトAgent の挙動と方針
ツールAgent が実行できる操作
SkillsAgent が呼び出せる高レベル能力
Agent 自体はタスクを実行しません。実際にタスクを実行するのは、Agent にバインドされた Session です。

フィールドリファレンス

フィールド必須説明
idstringシステム生成、ag_ プレフィックス
namestringはいAgent 名。英小文字 + ハイフン推奨(≤ 64 文字)
modelstringはいモデル識別子(下記参照)
systemstringいいえAgent 挙動を定義するシステムプロンプト
toolsarrayいいえ利用可能なツールリスト(下記参照)
skillsarrayいいえ関連付ける Skill ID リスト
metadataobjectいいえタグや絞り込み用のカスタム key/value
versionintegerバージョン番号、1 から始まる
created_atstring作成時刻(ISO 8601)
updated_atstring最終更新時刻

model

Agent が使用するモデルを指定する文字列です。
説明
"ultimate"最強モデル。複雑な推論や長時間タスクに最適
"auto"価格性能比が最も良いモデルを自動選択

tools

tools はツールオブジェクトの配列で、各エントリが Agent が実行できる 1 種類の操作を宣言します。
{
  "tools": [
    {"type": "bash_20250124"},
    {"type": "file_read"},
    {"type": "file_write"},
    {"type": "web_search"}
  ]
}
主なツールタイプ:
タイプ説明
bashShell コマンドを実行
file_readファイル内容を読み取り
file_writeファイルを作成・更新
web_searchWeb 検索
権限ポリシーを含む詳細は Agent ツール を参照してください。

Agent の管理

完全な CRUD インターフェイスは API Reference / Agents を参照してください。以下は典型的なワークフロー例です。

作成

curl -s -X POST https://openapi.qoder.sh/api/v1/cloud/agents \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "code-reviewer",
    "model": "ultimate",
    "system": "あなたはコードレビュー専門家です。コードを 1 行ずつレビューし、問題点と改善提案を Markdown で出力してください。",
    "tools": [
      {"type": "bash_20250124"},
      {"type": "file_read"},
      {"type": "file_write"}
    ],
    "metadata": {
      "team": "backend",
      "purpose": "code-review"
    }
  }' | jq .
成功時は 201 Created が返り、version1 から始まります。

取得

# 単一 Agent を取得
curl -s https://openapi.qoder.sh/api/v1/cloud/agents/ag_xxx \
  -H "Authorization: Bearer $QODER_PAT"

# ページネーション付き一覧
curl -s "https://openapi.qoder.sh/api/v1/cloud/agents?limit=20" \
  -H "Authorization: Bearer $QODER_PAT"

更新

更新リクエストには現在の version必ず含める必要があります。詳細は下記「バージョン管理」を参照してください。
curl -s -X PUT https://openapi.qoder.sh/api/v1/cloud/agents/ag_xxx \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "code-reviewer",
    "model": "ultimate",
    "system": "あなたはセキュリティとパフォーマンスに特化したシニアコードレビュー担当者です。",
    "version": 1
  }' | jq .
成功時は 200 OK が返り、version は自動的に +1 されます。

削除

curl -s -X DELETE https://openapi.qoder.sh/api/v1/cloud/agents/ag_xxx \
  -H "Authorization: Bearer $QODER_PAT"
Agent を削除しても、その Agent にバインドされた稼働中の Session は終了しません。Session は作成時に Agent 構成のスナップショットを保持しています。

バージョン管理

Agent は楽観的同時実行制御 (OCC) を採用しています。
  • 作成時、version1 から始まる
  • 更新成功のたびに version は自動的に +1
  • 更新リクエストには現在の version必ず含める必要がある。さもなくば 409 Conflict が返る
これにより、複数人 / 複数システムからの同時更新で書き戻しが発生するのを防ぎます。

409 への対処

保持しているバージョンが古い場合:
{
  "error": {
    "type": "conflict",
    "message": "Version mismatch: expected 2, got 1"
  }
}
復旧手順:
  1. GET で最新の Agent と version を取得
  2. 自分の変更をマージ
  3. 新しい version を付けて再度 PUT

ベストプラクティス

  1. 命名規則チーム-用途 形式(例: backend-code-reviewfrontend-test-gen
  2. 簡潔なプロンプトsystem には役割、出力形式、制約を明確に書く
  3. 最小ツールセット — タスクに必要なツールだけを付与し、誤操作リスクを減らす
  4. metadata の活用 — タグで分類し、後段の絞り込みや監査に役立てる
  5. 本番ではバージョン固定 — Session 作成時に {"id": ..., "version": ...} 形式で Agent バージョンを固定し、更新が本番挙動に影響するのを防ぐ

よくある質問

Q: Agent を更新すると、稼働中の Session にも影響しますか? 影響しません。Session は作成時点の Agent バージョンにバインドされており、その後の更新は伝播しません。 Q: tools 配列は空でも構いませんか? 構いません。ツールを持たない Agent はテキスト対話のみが可能で、操作は実行できません。 Q: name フィールドに長さ制限はありますか? 64 文字以内に収め、英小文字・数字・ハイフンを使用することを推奨します。 Q: 古いバージョンの Agent にロールバックするには? 現時点では自動ロールバックはサポートされていません。更新前に旧構成を控え、必要なときに最新の version を付けて手動で PUT し直してください。

次のステップ