> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/reference/ja/purattofmu/rest-api.md).

# REST API

Roboflow REST API はプラットフォームの公式インターフェースです。すべての機能はまずここに提供され、 [Python SDK](/reference/ja/purattofmu/python-sdk.md) および [CLI](/reference/ja/purattofmu/cli.md) はいずれも内部でこれを呼び出します。Python 以外の統合を構築している場合、Webhook やブラウザから呼び出す場合、または Python パッケージをインストールできない環境で作業している場合は、REST API を直接使用してください。

知っておくべき基本ホストは 2 つあります:

| ホスト                               | 用途                                                                                                                                       |
| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `https://api.roboflow.com`        | 管理 - ワークスペース、プロジェクト、バージョン、トレーニング、ワークフロー、データセット、ビジョンイベント、ゴミ箱。                                                                             |
| `https://serverless.roboflow.com` | ホスト型推論 - 学習済みモデルまたはワークフローを画像や動画に対して実行します。参照: [画像でモデルを実行する](https://docs.roboflow.com/deployment/roboflow-cloud/serverless-api#http-api). |

[専用デプロイメント](https://docs.roboflow.com/deployment/roboflow-cloud/dedicated-deployments#http-api) は、別のホスト（`https://roboflow.cloud`).

## リソース階層

Roboflow のデータモデルは階層構造になっており、API の URL もその階層に従っています:

* `/:workspace` - ワークスペース内のプロジェクト一覧、およびワークスペースのメタデータ。
* `/:workspace/:project` - プロジェクトのメタデータとバージョン一覧。
* `/:workspace/:project/:version` - 特定のデータセットバージョン、そのモデル（学習済みの場合）、およびダウンロード URL。
* `/:workspace/:project/:version/:format` - 特定の [エクスポート形式](https://roboflow.com/formats).
* `/:workspace/workflows/:workflow` - 参照: [ワークフローの管理](https://docs.roboflow.com/workflows/manage/manage-workflows#http-api).
* `/:workspace/groups` - プロジェクトフォルダ。参照: [プロジェクトフォルダの管理](https://docs.roboflow.com/datasets/manage/project-folders#http-api).
* `/:workspace/trash` - ソフト削除されたプロジェクト、バージョン、ワークフロー。参照: [ゴミ箱の管理](https://docs.roboflow.com/platform/workspaces/trash#http-api).

## ルートエンドポイント

最上位レベル（`https://api.roboflow.com/`）では、 `api_key` が機能していることを確認できます。レスポンスには、そのキーに属するワークスペースが表示されます:

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

```json
{
  "welcome": "Roboflow API へようこそ。",
  "instructions": "正常に認証されました。",
  "docs": "https://docs.roboflow.com",
  "workspace": "my-workspace"
}
```

そこから、 [ワークスペースとプロジェクトの一覧](https://docs.roboflow.com/platform/workspaces/list-workspaces-and-projects#http-api) を参照して、ワークスペース内に何があるか確認できます。

## 認証とスコープ

API キーはワークスペース単位です。キーはクエリパラメータ（`?api_key=...`）として、 `POST` リクエストの本文として、または `Authorization: Bearer ...` ヘッダーとして渡してください。参照: [REST API で認証する](/reference/ja/purattofmu/rest-api/authenticate-with-the-rest-api.md) 詳細については、また [スコープ付き API キー](/reference/ja/ren-zheng/authentication/scoped-api-keys.md) でリソースごとのスコープ参照をご覧ください。

## エラー

API は標準の HTTP ステータスコードと JSON のエラーボディを使用します。参照: [エラーとステータスコード](/reference/ja/errors-and-status-codes.md) で、ツール横断のエラー参照をご覧ください。