REST API के साथ उपयोग करें

Serverless Hosted API V2 में सभी मॉडलों और Workflows के लिए एक ही endpoint है:

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
सेमांटिक सेगमेंटेशन	वर्तमान में समर्थित नहीं है	https://segment.roboflow.com
Foundation models (जैसे CLIP, OCR, YOLO-World)	https://serverless.roboflow.com	https://infer.roboflow.com

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

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

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"
    }
  ]
}

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.