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

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

概要

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

HTTP API

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

エンドポイントの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": "物体検出",
                "name": "チェスサンプル",
                "created": 1630335544.592,
                "updated": 1630335741.988,
                "images": 12,
                "unannotated": 3,
                "annotation": "駒",
                "versions": 3,
                "public": false,
                "splits": {
                    "train": 9,
                    "test": 1,
                    "valid": 2
                },
                "classes": {
                    "白のクイーン": 7,
                    "黒のクイーン": 4,
                    "黒のビショップ": 8,
                    "白のナイト": 10,
                    "白のビショップ": 11,
                    "黒のナイト": 11,
                    "黒のルーク": 10,
                    "白のポーン": 34,
                    "黒のポーン": 37,
                    "白のルーク": 10,
                    "黒のキング": 8,
                    "白のキング": 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": "物体検出",
        "name": "チェスサンプル",
        "created": 1630335544.592,
        "updated": 1630335741.988,
        "images": 12,
        "unannotated": 3,
        "annotation": "駒",
        "public": false,
        "splits": {
            "valid": 2,
            "train": 9,
            "test": 1
        },
        "classes": {
            "白のクイーン": 7,
            "白のキング": 8,
            "黒のナイト": 11,
            "黒のポーン": 37,
            "黒のルーク": 10,
            "白のポーン": 34,
            "黒のビショップ": 8,
            "白のナイト": 10,
            "黒のクイーン": 4,
            "白のビショップ": 11,
            "黒のキング": 8,
            "白のルーク": 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": "引き伸ばす",
                        "width": 416,
                        "height": 416
                    },
                    "auto-orient": {
                        "enabled": true
                    }
                },
                "augmentation": {},
                "exports": []
            },
            {
                "id": "roboflow/chess-sample-4ckfl/1",
                "name": "拡張済み",
                "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": "引き伸ばす",
                        "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 value は、各モデルオブジェクトで返されるNAS実行識別子です。group がどのモデルにも一致しない場合、エンドポイントは空の配列を返します。

レスポンス

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

[
  {
    "url": "my-workspace/my-project/3",
    "version": "3",
    "train": { "status": "finished" },
    "modelType": "rfdetr-base",
    "name": "マイモデル",
    "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子モデル1",
  "created": "2026-04-01T00:00:00.000Z",
  "nasFamily": "子",
  "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

文字列

"子" NASで検出されたモデルの場合、 null ベースラインの場合

group

文字列

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

お気に入り

オブジェクト

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

recommended

真偽値

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

metrics.map5095

数値

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

metrics.f1

数値

F1スコア（割合）

metrics.hardware

文字列

モデルをベンチマークしたハードウェアターゲット（例： "gpu", "jetson-orin-nano")

metrics.latency

数値

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

metrics.paretoOptimalFor

文字列[]

このモデルがパレートフロンティア上に位置するハードウェアターゲット

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

Python SDK

取得する ワークスペース ハンドル（APIキーが認証されるワークスペース用）：

import roboflow

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

各Roboflow APIキーは単一のワークスペースにスコープされています。別のワークスペースで作業するには、別の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()` と同じデータですが、 list_projects() ただし プロジェクト オブジェクトのリスト（旧エイリアス）。
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() は バージョン 直接メソッドを呼び出せるオブジェクトを返します（download, train, deleteなど）。軽量なdictレスポンスが必要な場合は、 project.list_versions() または project.get_version_information().

バージョンを取得する

version = project.version(3)

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

CLI

ワークスペースを一覧表示する

CLIを使って、メンバーであるすべてのワークスペースの一覧を取得できます。

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

roboflow workspace list

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

名前             ID               デフォルト
マイワークスペース     my-workspace     *
その他のワークスペース  other-ws

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

roboflow workspace list --json

[
  {"name": "マイワークスペース", "url": "my-workspace", "link": "https://app.roboflow.com/my-workspace", "default": true},
  {"name": "その他のワークスペース", "url": "other-ws", "link": "https://app.roboflow.com/other-ws", "default": false}
]

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

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

roboflow project list

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

roboflow project list -w WORKSPACE_ID

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

名前              ID                              種類                バージョン数  画像数
マイデータセット        my-workspace/my-dataset         物体検出    3         500
分類器        my-workspace/classifier         分類      1         200

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

roboflow project list --json

プロジェクトを取得する

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

roboflow project get PROJECT_ID

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

roboflow project get my-dataset              # デフォルトのワークスペースを使用
roboflow project get my-workspace/my-dataset  # ワークスペースを明示指定

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

プロジェクト: マイデータセット
  ID: my-workspace/my-dataset
  種類: 物体検出
  画像数: 500
  バージョン数: 3
  クラス: 車 (200), トラック (150), バス (150)
  リンク: https://app.roboflow.com/my-workspace/my-dataset

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

roboflow project get my-dataset --json

前へワークスペース、プロジェクト、モデル次へワークスペースの名前を変更する

最終更新 5 日前

役に立ちましたか？