> 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/inference/inference-server-openapi.md). # Inference Server OpenAPI Browse and test the HTTP API for a self-hosted Roboflow Inference Server, with its machine-readable OpenAPI spec. A running [Inference Server](https://docs.roboflow.com/deployment/self-hosted/inference-server) publishes an OpenAPI specification that matches the version of the server you are running. The operations below come from the latest Inference release. You can also [download that OpenAPI spec](https://github.com/roboflow/docs/tree/main/reference/.gitbook/assets/inference-server.json). Start a server, then open its API reference in your browser: ```bash pip install inference-cli inference server start ```
EndpointWhat it serves
http://localhost:9001/docsSwagger UI with an interactive request builder.
http://localhost:9001/redocReDoc reference for the same specification.
The API reference below uses `http://localhost:9001`, the default address for a local Inference Server. Replace this base URL with the address of the server you want to call: * Use `https://serverless.roboflow.com` for the [Serverless Hosted API](https://docs.roboflow.com/deployment/roboflow-cloud/serverless-api). * Use the assigned URL for a [Dedicated Deployment](https://docs.roboflow.com/deployment/roboflow-cloud/dedicated-deployments). * Use the IP address or hostname and port for another self-hosted Inference Server. {% hint style="info" %} This is the API for running models and Workflows. For the Roboflow Platform API for workspaces, projects, versions, and training, see the [Platform API OpenAPI reference](/reference/platform/rest-api/platform-api-openapi.md). {% endhint %} ## Server {% openapi src="/files/UaOx4PT011KayfI4lGf2" path="/healthz" method="get" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/readiness" method="get" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/info" method="get" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/metrics" method="get" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/logs" method="get" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/dashboard.html" method="get" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/dashboard.html" method="head" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/model/registry" method="get" %} [inference-server.json](https://2143050199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media) {% endopenapi %} ## Core inference {% openapi src="/files/UaOx4PT011KayfI4lGf2" path="/{dataset\_id}/{version\_id}" method="get" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/{dataset\_id}/{version\_id}" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/infer/depth-estimation" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/infer/depth-estimation/{model\_id}" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/infer/lmm" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/infer/lmm/{model\_id}" method="post" %} [inference-server.json](https://2143050199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media) {% endopenapi %} ## Embeddings and comparison {% openapi src="/files/UaOx4PT011KayfI4lGf2" path="/clip/compare" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/clip/embed\_image" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/clip/embed\_text" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/perception\_encoder/compare" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/perception\_encoder/embed\_image" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/perception\_encoder/embed\_text" method="post" %} [inference-server.json](https://2143050199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media) {% endopenapi %} ## Segmentation and detection {% openapi src="/files/UaOx4PT011KayfI4lGf2" path="/grounding\_dino/infer" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/owlv2/infer" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/yolo\_world/infer" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/sam/embed\_image" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/sam/segment\_image" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/sam2/embed\_image" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/sam2/segment\_image" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/sam3/embed\_image" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/sam3/concept\_segment" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/sam3/visual\_segment" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/sam3\_3d/infer" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/doctr/ocr" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/easy\_ocr/ocr" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/ocr/pp-ocr" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/ocr/trocr" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/initialise\_webrtc\_worker" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/webrtc/session/heartbeat" method="post" %} [inference-server.json](https://2143050199-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/UaOx4PT011KayfI4lGf2" path="/webrtc/session/heartbeat/end" method="post" %} [inference-server.json](https://2143050199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-83e67fddbfefb900aec405e586c787c83f66a20c%2Finference-server.json?alt=media) {% endopenapi %}