Use with the REST API

Serverless Hosted API V2 は、すべてのモデルと Workflows のために1つのエンドポイントを持ちます：

https://serverless.roboflow.com

Model Type	Serverless Hosted API V2	Hosted API V1
Object detection, Keypoint detection	https://serverless.roboflow.com	https://detect.roboflow.com
インスタンスセグメンテーション	https://serverless.roboflow.com	https://outline.roboflow.com
分類	https://serverless.roboflow.com	https://classify.roboflow.com
セマンティックセグメンテーション	Currently not supported	https://segment.roboflow.com
Foundation models (i.e. CLIP, OCR, YOLO-World)	https://serverless.roboflow.com	https://infer.roboflow.com

Make Requests with HTTP

Endpoint to run predefined workflow

post

Checks Roboflow API for workflow definition, once acquired - parses and executes injecting runtime parameters from request body

Path parameters

workspace_namestringRequired

workflow_idstringRequired

Body

application/json

api_keyany ofOptional

Roboflow API Key that will be passed to the model during initialization for artifact retrieval

stringOptional

or

nullOptional

excluded_fieldsany ofOptional

List of field that shall be excluded from the response (among those defined in workflow specification)

string[]Optional

or

nullOptional

enable_profilingbooleanOptional

Flag to request Workflow run profiling. Enables Workflow profiler only when server settings allow profiling traces to be exported to clients. Only applies for Workflows definitions saved on Roboflow platform.

Default: false

workflow_idany ofOptional

Optional identifier of workflow

stringOptional

or

nullOptional

use_cachebooleanOptional

Controls usage of cache for workflow definitions. Set this to False when you frequently modify definition saved in Roboflow app and want to fetch the newest version for the request.

Default: true

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/{workspace_name}/workflows/{workflow_id}

HTTPcURLJavaScriptPython

POST /{workspace_name}/workflows/{workflow_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 156

{
  "api_key": "text",
  "inputs": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "excluded_fields": [
    "text"
  ],
  "enable_profiling": false,
  "workflow_id": "text",
  "use_cache": true
}

{
  "outputs": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "profiler_trace": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Make Requests with the Python SDK

Pythonで作業している場合、Serverless API とやり取りする最も便利な方法は Inference Python SDK を使用することです。

SDK を使用するには、まずそれをインストールしてください：

pip install inference-sdk

Serverless Hosted API V2 にリクエストを行うには、次のコードを使用してください：

from inference_sdk import InferenceHTTPClient

CLIENT = InferenceHTTPClient(
    api_url="https://serverless.roboflow.com",
    api_key="API_KEY"
)

result = CLIENT.infer(your_image.jpg, model_id="model-id/1")

上記で、次を指定してください： model ID および API key.