ワークスペースとプロジェクトを一覧表示する

REST API、Python SDK、CLI を使用して、ワークスペース、プロジェクト、バージョン、学習済みモデルを一覧表示します。

概要

ワークスペースのエンドポイントは、ワークスペースとその中に含まれるすべてのプロジェクトに関するメタデータを返します。これには、各プロジェクトの種類、画像数とアノテーション数、バージョン、データセットの分割が含まれます。API キーでアクセスできるプロジェクトを列挙するため（たとえば、データのアップロードやバージョンのエクスポート前にプロジェクト ID を見つけるため）や、プロジェクトで生成されたバージョン、学習済みモデル、データセットのエクスポートを掘り下げて確認するために使用します。これと同じデータは、REST API、Python SDK、CLI からも利用できます。

HTTP API

その /:workspace エンドポイントは、ワークスペースとその Projects に関する情報を返します。このエンドポイントは、API キーで認証された Workspace 内のすべての Projects を一覧表示し、各 project をさらに掘り下げて、生成されたバージョン、モデル、データセットのエクスポートに関する情報を確認できます。

エンドポイント URL は次のとおりです:

curl "https://api.roboflow.com/roboflow?api_key=$ROBOFLOW_API_KEY"

以下は、このエンドポイントからのレスポンス例です:

{
    "workspace": {
        "name": "Roboflow",
        "url": "roboflow",
        "members": 7,
        "projects": [
            {
                "id": "roboflow/chess-sample-4ckfl",
                "type": "object-detection",
                "name": "Chess Sample",
                "created": 1630335544.592,
                "updated": 1630335741.988,
                "images": 12,
                "unannotated": 3,
                "annotation": "pieces",
                "versions": 3,
                "public": false,
                "splits": {
                    "train": 9,
                    "test": 1,
                    "valid": 2
                },
                "classes": {
                    "white-queen": 7,
                    "black-queen": 4,
                    "black-bishop": 8,
                    "white-knight": 10,
                    "white-bishop": 11,
                    "black-knight": 11,
                    "black-rook": 10,
                    "white-pawn": 34,
                    "black-pawn": 37,
                    "white-rook": 10,
                    "black-king": 8,
                    "white-king": 8
                }
            }
        ]
    }
}

プロジェクトの取得とバージョン一覧

次の REST エンドポイントを使って、プロジェクトに関する情報を取得できます:

curl "https://api.roboflow.com/roboflow/chess-sample-4ckfl?api_key=$ROBOFLOW_API_KEY"

このエンドポイントは、次の構造を持つ JSON レスポンスを返します:

{
    "workspace": {
        "name": "Roboflow",
        "url": "roboflow",
        "members": 7
    },
    "project": {
        "id": "roboflow/chess-sample-4ckfl",
        "type": "object-detection",
        "name": "Chess Sample",
        "created": 1630335544.592,
        "updated": 1630335741.988,
        "images": 12,
        "unannotated": 3,
        "annotation": "pieces",
        "public": false,
        "splits": {
            "valid": 2,
            "train": 9,
            "test": 1
        },
        "classes": {
            "white-queen": 7,
            "white-king": 8,
            "black-knight": 11,
            "black-pawn": 37,
            "black-rook": 10,
            "white-pawn": 34,
            "black-bishop": 8,
            "white-knight": 10,
            "black-queen": 4,
            "white-bishop": 11,
            "black-king": 8,
            "white-rook": 10
        },
        "versions": [
            {
                "id": "roboflow/chess-sample-4ckfl/3",
                "name": "raw",
                "created": 1630335741.989,
                "images": 12,
                "splits": {
                    "train": 9,
                    "test": 1,
                    "valid": 2
                },
                "preprocessing": {
                    "auto-orient": {
                        "enabled": true
                    }
                },
                "augmentation": {},
                "exports": [
                    "coco",
                    "voc"
                ]
            },
            {
                "id": "roboflow/chess-sample-4ckfl/2",
                "name": "416x416",
                "created": 1630335730.142,
                "images": 12,
                "splits": {
                    "train": 9,
                    "test": 1,
                    "valid": 2
                },
                "preprocessing": {
                    "resize": {
                        "enabled": true,
                        "format": "Stretch to",
                        "width": 416,
                        "height": 416
                    },
                    "auto-orient": {
                        "enabled": true
                    }
                },
                "augmentation": {},
                "exports": []
            },
            {
                "id": "roboflow/chess-sample-4ckfl/1",
                "name": "augmented",
                "created": 1630335698.746,
                "images": 30,
                "splits": {
                    "valid": 2,
                    "train": 27,
                    "test": 1
                },
                "model": {
                    "id": "chess-sample-4ckfl/1",
                    "endpoint": "https://serverless.roboflow.com/infer/chess-sample-4ckfl/1",
                    "start": 1630335799.682,
                    "end": 1630337523.889,
                    "fromScratch": false,
                    "tfjs": true,
                    "oak": true,
                    "map": "62.87",
                    "recall": "85.29",
                    "precision": "23.44"
                },
                "preprocessing": {
                    "resize": {
                        "enabled": true,
                        "width": 416,
                        "format": "Stretch to",
                        "height": 416
                    },
                    "auto-orient": {
                        "enabled": true
                    },
                    "grayscale": {
                        "enabled": true
                    }
                },
                "augmentation": {
                    "exposure": {
                        "percent": "25",
                        "enabled": true
                    },
                    "brightness": {
                        "percent": "25",
                        "enabled": true,
                        "darken": true,
                        "brighten": true
                    },
                    "rotate": {
                        "degrees": "5",
                        "enabled": true
                    },
                    "image": {
                        "enabled": true,
                        "versions": "3"
                    },
                    "flip": {
                        "enabled": true,
                        "horizontal": true,
                        "vertical": false
                    },
                    "crop": {
                        "min": 0,
                        "percent": 30,
                        "enabled": true
                    },
                    "noise": {
                        "percent": "2",
                        "enabled": true
                    }
                },
                "exports": [
                    "yolov5pytorch"
                ],
                "versionNotes": "修正: 回転ボックスのずれ"
            }
        ]
    }
}

プロジェクトモデル一覧

次を使って、プロジェクト内のすべての学習済みモデルを取得できます /:workspace/:project/models エンドポイント。このエンドポイントは、バージョンで学習されたモデルとスタンドアロンモデル（NAS の子モデルなど）の両方を返します。

で Roboflow でサインイン（はじめに）、使用します Authorization: Bearer およびスコープ model:infer の代わりに api_key:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
  "https://api.roboflow.com/:workspace/:project/models"

すべてのモデルを一覧表示

curl "https://api.roboflow.com/:workspace/:project/models?api_key=$ROBOFLOW_API_KEY"

NAS グループで絞り込み

特定の NAS 実行のモデルだけを一覧表示するには、 group クエリパラメータを渡します:

curl "https://api.roboflow.com/:workspace/:project/models?group=GROUP_ID&api_key=$ROBOFLOW_API_KEY"

その group group の値は、各モデルオブジェクトで返される NAS 実行識別子です。group がどのモデルにも一致しない場合、エンドポイントは空の配列を返します。

レスポンス

このエンドポイントは、モデルオブジェクトの JSON 配列を返します:

[
  {
    "url": "my-workspace/my-project/3",
    "version": "3",
    "train": { "status": "finished" },
    "modelType": "rfdetr-base",
    "name": "My Model",
    "created": "2026-04-01T00:00:00.000Z",
    "metrics": {
      "map50": 91.0,
      "precision": 88.0,
      "recall": 85.0
    }
  }
]

NAS モデルのフィールド

によって生成されたモデルにはニューラル・アーキテクチャ・サーチに追加のフィールドが含まれます:

{
  "url": "my-workspace/my-project-410-nas-gpu-066866",
  "train": { "status": "finished" },
  "modelType": "rfdetr-nas-S",
  "name": "NAS Child 1",
  "created": "2026-04-01T00:00:00.000Z",
  "nasFamily": "child",
  "group": "pVYKOWUB6AUIVJMgPc7u-410-rfdetrNasGroup",
  "favorites": {},
  "recommended": true,
  "metrics": {
    "map50": 81.2,
    "map5095": 64.3,
    "f1": 78.0,
    "hardware": "gpu",
    "latency": 1.157,
    "paretoOptimalFor": ["gpu"]
  }
}

フィールド

型

説明

nasFamily

string

"child" NAS で見つかったモデルの場合、 null ベースラインの場合

group

string

NAS 実行識別子。同じ実行内のすべてのモデルで共有されます

お気に入り

object

ユーザー ID とお気に入り状態のマップ

recommended

boolean

存在し、 true このモデルが少なくとも 1 つの指標/ハードウェアの組み合わせで推奨候補である場合

metrics.map5095

数値

mAP@50-95 のスコア（割合）

metrics.f1

数値

F1 スコア（割合）

metrics.hardware

string

このモデルをベンチマークしたハードウェア対象（例: "gpu", "jetson-orin-nano")

metrics.latency

数値

対象ハードウェアでの推論レイテンシ（ミリ秒）

metrics.paretoOptimalFor

string[]

このモデルがパレートフロンティア上にあるハードウェア対象

これらのフィールドは NAS モデルにのみ存在します。標準の学習済みモデルには影響しません。

Python SDK

の ワークスペース ハンドルを、API キーで認証されたワークスペースに対して取得します:

import roboflow

rf = roboflow.Roboflow(api_key="YOUR_API_KEY")
workspace = rf.workspace()

各 Roboflow API キーは 1 つのワークスペースに紐づいています。別のワークスペースで使うには、別の API キーを使用してください（または、公開 Universe ワークスペースの場合はワークスペースのスラッグを渡してください）:

# 公開 Universe ワークスペース - 必要なのはあなたの API キーだけです。
public_ws = rf.workspace("roboflow-100")

ワークスペースのプロパティ

返される ワークスペース は次を公開します:

workspace.url - ワークスペースの URL スラッグ（例: my-workspace).
workspace.name - ワークスペースの表示名。
workspace.list_projects() - ワークスペース内のプロジェクト。dict のリストとして返されます。
workspace.projects() - と同じデータですが、 list_projects() として返されます Project オブジェクトのリスト（旧エイリアス）。
workspace.list_folders() - 参照: フォルダの管理.
workspace.list_workflows() - 参照: ワークフローの管理.
workspace.get_plan() および workspace.get_usage() - 参照: ワークスペースのプランと使用状況.

プロジェクトとバージョンの一覧

プロジェクトの一覧

ワークスペース内のプロジェクトを取得します:

import roboflow

rf = roboflow.Roboflow(api_key="YOUR_API_KEY")
workspace = rf.workspace()

for project in workspace.list_projects():
    print(project["id"], project["name"], project["type"] )

各エントリには、プロジェクトの id（URL スラッグ）、表示名、プロジェクトの種類、画像数、その他いくつかのメタデータフィールドが含まれます。

公開 Universe ワークスペースで使うには、そのスラッグを渡してください:

universe_ws = rf.workspace("roboflow-100")

プロジェクトを取得

project = workspace.project("my-detector")

または、トップレベルのショートカットを使います:

project = rf.project("my-detector")

バージョン一覧

for version in project.versions():
    print(version.version, version.name)

project.versions() を返します Version メソッドを直接呼び出せるオブジェクト（download, train, deleteなど）。軽量な dict レスポンスが必要なら、次を使います: project.list_versions() または project.get_version_information().

バージョンを取得

version = project.version(3)

数値指定 - バージョン番号は 1 から始まります。

CLI

ワークスペース一覧

CLI を使って、所属しているすべてのワークスペースの一覧を取得できます。

CLI でワークスペースを一覧表示するには、次のコマンドを使います:

roboflow workspace list

これにより、対応するアプリケーションリンクとワークスペース ID を含むワークスペース一覧が返されます:

NAME             ID               DEFAULT
My Workspace     my-workspace     *
Other Workspace  other-ws

JSON として出力を取得するには（スクリプトや AI エージェントで使用する場合）:

roboflow workspace list --json

[
  {"name": "My Workspace", "url": "my-workspace", "link": "https://app.roboflow.com/my-workspace", "default": true},
  {"name": "Other Workspace", "url": "other-ws", "link": "https://app.roboflow.com/other-ws", "default": false}
]

ワークスペース内のプロジェクト一覧

ワークスペース内のプロジェクトを一覧表示するには、次のコマンドを使います:

roboflow project list

デフォルトのワークスペースが設定されている場合、 -w フラグは省略可能です。そうでない場合は、次のように指定します:

roboflow project list -w WORKSPACE_ID

これにより、プロジェクトの表が返されます:

NAME              ID                              TYPE                VERSIONS  IMAGES
my-dataset        my-workspace/my-dataset         object-detection    3         500
classifier        my-workspace/classifier         classification      1         200

JSON として出力を取得するには:

roboflow project list --json

プロジェクトを取得

プロジェクトの詳細情報を取得するには、次のコマンドを使います:

roboflow project get PROJECT_ID

リソースの省略形を使えます。ワークスペースを別途指定する必要はありません:

roboflow project get my-dataset              # uses default workspace
roboflow project get my-workspace/my-dataset  # explicit workspace

これにより、バージョンを含むプロジェクト情報が返されます:

Project: my-dataset
  ID: my-workspace/my-dataset
  Type: object-detection
  Images: 500
  Versions: 3
  Classes: car (200), truck (150), bus (150)
  Link: https://app.roboflow.com/my-workspace/my-dataset

完全な JSON レスポンスを取得するには:

roboflow project get my-dataset --json

MCPサーバー

AI エージェントを次に接続すると、 MCPサーバーすると、これらのツールでワークスペース内の内容を一覧表示できます:

ツール

説明

projects_list

ワークスペース内のプロジェクトを一覧表示します。

projects_get

バージョン、クラス、分割、学習済みモデルを含むプロジェクトの詳細を取得します。

前へワークスペース、プロジェクト、モデル

次へワークスペースの名前を変更する

最終更新 26 日前

役に立ちましたか？