:エージェントの定義

基本概念

エージェントは「職務記述書」のようなものと考えることができます。

エージェント自体はタスクを実行しません。単なる設定です。タスクの実行は、そのエージェントにバインドされたセッションが処理します。

パラメーターリファレンス

モデル

model フィールドは、エージェントが使用するモデルを指定します。

ツール

tools フィールドはツールオブジェクトの配列です。現在、サポートされているツールセットは agent_toolset_20260401 のみです。enabled_tools 配列にリストすることで、このツールセット内のアトミックツールを有効にします。

{
  "tools": [
    {
      "type": "agent_toolset_20260401",
      "enabled_tools": ["Bash", "Read", "Write", "Edit", "Glob", "Grep", "WebFetch", "WebSearch"]
    }
  ]
}

enabled_tools で使用可能な値 (値は大文字と小文字を区別し、パスカルケースで指定する必要があります)：

その他のツール設定については、「エージェントのツール設定」をご参照ください。

エージェントの管理

すべての CRUD 操作については、「APIリファレンス / エージェント」をご参照ください。以下の例は、一般的なワークフローを対象としています。

作成

curl -s -X POST https://api.qoder.com.cn/api/v1/cloud/agents \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "code-reviewer",
    "model": "auto",
    "instructions": "あなたはコードレビューの専門家です。コードを行ごとにレビューし、問題点と改善案を Markdown 形式で出力してください。",
    "tools": [
      {
        "type": "agent_toolset_20260401",
        "enabled_tools": ["Bash", "Read", "Write"]
      }
    ],
    "metadata": {
      "team": "backend",
      "purpose": "code-review"
    }
  }' | jq .

リクエストが成功すると、201 Created が返ります。version は 1 から始まります。

取得

# 単一のエージェントを取得
curl -s https://api.qoder.com.cn/api/v1/cloud/agents/agent_xxx \
  -H "Authorization: Bearer $QODER_PAT"

# ページネーション付きでエージェントを一覧表示
curl -s "https://api.qoder.com.cn/api/v1/cloud/agents?limit=20" \
  -H "Authorization: Bearer $QODER_PAT"

更新

エージェントを更新する際は、現在の version を必ず指定する必要があります。詳細については、以下の「バージョン管理」をご参照ください。

curl -s -X PUT https://api.qoder.com.cn/api/v1/cloud/agents/agent_xxx \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "code-reviewer",
    "model": "auto",
    "instructions": "あなたはシニアコードレビューの専門家です。セキュリティの脆弱性とパフォーマンスの問題に焦点を当ててください。",
    "version": 1
  }' | jq .

リクエストが成功すると、200 OK が返り、version が 1 ずつインクリメントされます。

削除

curl -s -X DELETE https://api.qoder.com.cn/api/v1/cloud/agents/agent_xxx \
  -H "Authorization: Bearer $QODER_PAT"

エージェントを削除しても、それにバインドされているアクティブセッションは終了しません。セッションは作成時にエージェントの設定をスナップショットとして保存します。

バージョン管理

エージェント API は、オプティミスティック同時実行制御 (OCC) を使用します。

• version は作成時に 1 から始まります。

• 更新が成功するたびに、version は自動的に 1 ずつインクリメントされます。

• 更新リクエストには、現在の version を必ず含める必要があります。失敗するシナリオは 2 つあります。

  • version フィールドが欠落している場合 — 400 invalid_request_error ("Field 'version' is required.") が返ります。

  • 指定された version がサーバー側のバージョンと一致しない場合、409 conflict_error が返されます。

これにより、同時実行される変更がお互いを上書きすることを防ぎます。

409競合の処理

バージョンが古いためにリクエストが失敗した場合、次のエラーが表示されます。

{
  "type": "error",
  "error": {
    "type": "conflict_error",
    "message": "Version conflict. Expected version 2, got 1."
  }
}

競合を解決するには、以下の手順を実行します。

1. GET で最新のエージェントを取得し、現在の version を取得します。

2. 最新のオブジェクトデータに、目的の変更を再適用します。

3. 新しい version を使用して、再度 PUT を実行します。

ベストプラクティス

1. 命名規則 — backend-code-review や frontend-test-gen のように、team-purpose 形式を使用します。

2. プロンプトの改良 — system フィールドで役割、出力形式、制約を指定します。

3. 最小権限の原則の適用 — リスクを最小限に抑えるため、タスクに不可欠な tools のみを付与してください。

4. メタデータの効果的な使用 — キーバリューペアを追加してエージェントを分類し、フィルタリングや監査を容易にします。

5. 本番環境でのバージョンロック — セッションを作成する際に {"id": ..., "version": ...} 形式を使用してエージェントのバージョンをロックしてください。これにより、新しいバージョンがオンラインサービスに影響を与えるのを防げます。

よくある質問

Q： エージェントを更新すると、現在実行中のセッションに影響しますか？ いいえ。セッションは作成時に特定のエージェントバージョンにバインドされます。 Q： tools 配列は空にできますか？ はい。tools のないエージェントは、テキストベースの対話しかできず、アクションを実行できません。 Q： name フィールドに長さの制限はありますか？ 64 文字未満に保ち、小文字、数字、ハイフンを使用してください。 Q： 古いバージョンのエージェントにロールバックするにはどうすればよいですか？ 自動ロールバックはサポートされていません。更新する前にエージェントの設定を保存してください。元に戻すには、最新の version 番号で古い設定を PUT してください。