> 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/inference/inference-server-openapi.md).

# Inference Server OpenAPI

機械可読な OpenAPI 仕様付きの、セルフホスト型 Roboflow Inference Server 向け HTTP API を参照・テストできます。

実行中の [推論サーバー](https://docs.roboflow.com/deployment/self-hosted/inference-server) 実行中のサーバーのバージョンに一致する OpenAPI 仕様を公開します。

以下の操作は最新の Inference リリースからのものです。また、 [その OpenAPI 仕様をダウンロードできます](https://github.com/roboflow/docs/tree/main/reference/.gitbook/assets/inference-server.json).

サーバーを起動し、次にブラウザーでその API リファレンスを開いてください:

```bash
pip install inference-cli
inference server start
```

<table data-search="false"><thead><tr><th>エンドポイント</th><th>提供内容</th></tr></thead><tbody><tr><td><code>http://localhost:9001/docs</code></td><td>対話型リクエストビルダー付きの Swagger UI。</td></tr><tr><td><code>http://localhost:9001/redoc</code></td><td>同じ仕様の ReDoc リファレンス。</td></tr></tbody></table>

以下の API リファレンスは `http://localhost:9001`は、ローカル Inference Server のデフォルトアドレスです。このベース URL を、呼び出したいサーバーのアドレスに置き換えてください:

* 使用 `https://serverless.roboflow.com` で [サーバーレスホスト型 API](https://docs.roboflow.com/deployment/roboflow-cloud/serverless-api).
* 割り当てられた URL を使用してください [専用デプロイメント](https://docs.roboflow.com/deployment/roboflow-cloud/dedicated-deployments).
* 別のセルフホスト型 Inference Server には、IP アドレスまたはホスト名とポートを使用してください。

{% hint style="info" %}
これはモデルと Workflow を実行するための API です。ワークスペース、プロジェクト、バージョン、トレーニング用の Roboflow Platform API については、 [Platform API OpenAPI リファレンス](https://docs.roboflow.com/reference/ja/platform/rest-api/platform-api-openapi.md).
{% endhint %}

## サーバー

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/healthz" method="get" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/readiness" method="get" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/info" method="get" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/metrics" method="get" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/logs" method="get" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/dashboard.html" method="get" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/dashboard.html" method="head" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/model/registry" method="get" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

## コア推論

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/{dataset\_id}/{version\_id}" method="get" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/{dataset\_id}/{version\_id}" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/infer/depth-estimation" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/infer/depth-estimation/{model\_id}" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/infer/lmm" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/infer/lmm/{model\_id}" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

## 埋め込みと比較

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/clip/compare" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/clip/embed\_image" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/clip/embed\_text" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/perception\_encoder/compare" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/perception\_encoder/embed\_image" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/perception\_encoder/embed\_text" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

## セグメンテーションと検出

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/grounding\_dino/infer" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/owlv2/infer" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/yolo\_world/infer" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/sam/embed\_image" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/sam/segment\_image" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/sam2/embed\_image" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/sam2/segment\_image" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/sam3/embed\_image" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/sam3/concept\_segment" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/sam3/visual\_segment" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/sam3\_3d/infer" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

## OCR

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/doctr/ocr" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/easy\_ocr/ocr" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/ocr/pp-ocr" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/ocr/trocr" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

## WebRTC

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/initialise\_webrtc\_worker" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/webrtc/session/heartbeat" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}

{% openapi src="/files/f7ea0d9779f49be7842bfc6c51314233529412d9" path="/webrtc/session/heartbeat/end" method="post" %}
[inference-server.json](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media)
{% endopenapi %}
