メインコンテンツへスキップ
GET /api/v1/cloud/agents 現在のアカウント配下の Agent 一覧を取得します。デフォルトではアーカイブ済み Agent は含まれません。include_archived=true を指定するとアーカイブ済み Agent も含まれます。

リクエストヘッダー

ヘッダー必須説明
AuthorizationはいBearer <PAT>

クエリパラメーター

パラメーター必須デフォルト説明
limitintegerいいえ201ページあたりの取得件数。範囲は 1〜100。100 を超える値は 400 invalid_request_error を返します
pagestringいいえ-前回のレスポンスの next_page で返されたカーソル
include_archivedbooleanいいえfalsetrue に設定するとアーカイブ済み Agent を含めます
created_at[gte]stringいいえ-この RFC 3339 タイムスタンプ以降に作成された Agent のみを返します
created_at[lte]stringいいえ-この RFC 3339 タイムスタンプ以前に作成された Agent のみを返します
ページネーションの詳細はページネーションを参照してください。

リクエスト例

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

レスポンス例

HTTP 200 OK
{
  "data": [
    {
      "type": "agent",
      "id": "agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "name": "doc-test-agent",
      "description": "",
      "model": "ultimate",
      "system": "You are a documentation testing assistant.",
      "tools": [],
      "mcp_servers": [],
      "skills": [],
      "metadata": {},
      "multiagent": null,
      "version": 1,
      "archived_at": null,
      "created_at": "2026-05-18T15:26:39.61669Z",
      "updated_at": "2026-05-18T15:26:39.61669Z"
    },
    {
      "type": "agent",
      "id": "agent_019eYYYYYYYYYYYYYYYYYYYYYYYYYYYY",
      "name": "test-agent-e2e",
      "description": "Agent used for end-to-end testing",
      "model": "ultimate",
      "system": "You are a testing assistant.",
      "tools": [],
      "mcp_servers": [],
      "skills": [],
      "metadata": {},
      "multiagent": null,
      "version": 2,
      "archived_at": null,
      "created_at": "2026-05-18T03:04:33.952256Z",
      "updated_at": "2026-05-18T03:05:28.023697Z"
    }
  ],
  "first_id": "agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "last_id": "agent_019eYYYYYYYYYYYYYYYYYYYYYYYYYYYY",
  "has_more": true,
  "next_page": "agent_019eYYYYYYYYYYYYYYYYYYYYYYYYYYYY"
}

レスポンスフィールド

フィールド説明
dataAgent オブジェクトの配列現在のページの Agent
first_idstring現在のページの最初のレコードの ID
last_idstring現在のページの最後のレコードの ID
has_morebooleanさらにデータが存在するかどうか
next_pagestring|null次ページのカーソル。has_more が true の場合は last_id と同じ値、それ以外は null

ページネーション

次のページを取得する:
curl "https://api.qoder.com/api/v1/cloud/agents?limit=20&page=agent_019eYYYY..."

エラー

HTTPtype発生条件
400invalid_request_errorlimit が正の整数でない
400invalid_request_errorページネーションカーソルが不正
400invalid_request_errorcreated_at[gte] または created_at[lte] が RFC 3339 形式でない
401authentication_errorPAT が無効または期限切れ
403permission_errorこの操作を実行する権限がない
エラーレスポンスの完全な形式についてはエラーを参照してください。

注意事項

  • デフォルトでは ID の降順で返されます。
  • アーカイブ済み Agent はデフォルトの一覧には表示されません。include_archived=true を指定するとアーカイブ済み Agent を含めることができます。
  • カーソルベースのページネーション(cursor-based pagination)を使用しており、オフセット方式には対応していません。

関連

Agent の定義

再利用可能でバージョン管理された Agent 構成を作成する。