メインコンテンツへスキップ
GET /v1/agents/{agent_id} 指定された Agent の詳細情報を取得します。

ヘッダー

ヘッダー必須説明
AuthorizationはいBearer <PAT>
X-CAS-Include-Extendedいいえtrue に設定すると拡張フィールド(skillsmetadata)がレスポンスに含まれます

パスパラメータ

パラメータ必須説明
agent_idstringはいAgent の一意識別子、agent_ プレフィックス + UUID 形式

リクエスト例

curl -X GET "https://api.qoder.com/api/v1/cloud/agents/agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Authorization: Bearer $QODER_PAT"

リクエスト例(拡張フィールド付き)

curl -X GET "https://api.qoder.com/api/v1/cloud/agents/agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "X-CAS-Include-Extended: true"

レスポンス例

HTTP 200 OK
{
  "type": "agent",
  "id": "agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "name": "doc-test-agent",
  "description": "",
  "model": "ultimate",
  "system": "あなたはドキュメントテストアシスタントです",
  "instructions": "あなたはドキュメントテストアシスタントです",
  "tools": [],
  "mcp_servers": [],
  "skills": [
    {"type": "custom", "skill_id": "skill_019e5d133c057536872f745e0b6dbd5d"}
  ],
  "metadata": {},
  "default_environment": "",
  "version": 1,
  "archived": false,
  "archived_at": null,
  "created_at": "2026-05-18T15:26:39.61669Z",
  "updated_at": "2026-05-18T15:26:39.61669Z"
}
X-CAS-Include-Extended: true ヘッダーを付与しない場合、レスポンスに skillsmetadata フィールドは含まれません。

レスポンスフィールド

フィールド説明
typestring固定値 "agent"
idstringAgent の一意識別子
namestringAgent 名
descriptionstringAgent の説明
modelstringモデル識別子
instructionsstringシステムプロンプト
systemstringinstructions のエイリアス(非推奨、instructions を使用してください)
toolsarrayツール設定リスト
mcp_serversarrayMCP サーバー設定
skillsarraySkill バインディングリスト(拡張フィールド、X-CAS-Include-Extended: true が必要)
metadataobjectカスタムメタデータ(拡張フィールド、X-CAS-Include-Extended: true が必要)
default_environmentstringデフォルトの実行環境
versioninteger現在のバージョン番号
archivedbooleanアーカイブ済みかどうか
archived_atstring|nullアーカイブ時刻(ISO 8601)、未アーカイブの場合は null
created_atstring作成時刻(ISO 8601)
updated_atstring最終更新時刻(ISO 8601)

エラーコード

HTTPtypeトリガー条件
401authentication_errorPAT が無効または期限切れ
403permission_errorこの Agent にアクセスする権限がない
404not_found_error指定 ID の Agent が存在しない

エラーレスポンス例

{
  "type": "error",
  "error": {
    "type": "not_found_error",
    "message": "Agent 'agent_nonexistent' was not found."
  }
}