> 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/platform/rest-api.md).

# REST API

Roboflow REST API のホスト、リソース階層、ルートエンドポイント、認証方法の概要。

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

知っておくべきベースホストは2つあります。

| ホスト                               | 用途                                                                                                                                             |
| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `https://api.roboflow.com`        | 管理 - ワークスペース、プロジェクト、バージョン、トレーニング、ワークフロー、データセット、Visionイベント、ゴミ箱。                                                                                 |
| `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) は3つ目のホスト（`https://roboflow.cloud`).

## リソース階層

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

* `/:workspace` - ワークスペース内のプロジェクト一覧と、ワークスペースのメタデータ。
* `/:workspace/:project` - プロジェクトのメタデータとバージョン一覧。
* `/:workspace/:project/:version` - 特定のデータセットバージョン、そのモデル（学習済みの場合）、およびそのトレーニング実行。
* `/: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 -H "Authorization: Bearer $ROBOFLOW_API_KEY" "https://api.roboflow.com/"
```

```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キーはワークスペース単位です。キーは `Authorization: Bearer ...` ヘッダーとして送信してください。クエリパラメータ（`?api_key=...`）として、または `POST` 呼び出しのリクエストボディに含める方法は旧式のチャネルです。今でも動作しますが、キーがURLやログに残るため、新しいコードには推奨されません。参照： [REST APIで認証する](https://docs.roboflow.com/reference/ja/platform/rest-api/authenticate-with-the-rest-api.md) 詳細は [高度なAPIキー](https://docs.roboflow.com/reference/ja/ren-zheng/authentication/scoped-api-keys.md) で、リソースごとのスコープ参照を確認してください。

## エラー

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