Submit a clustering job

POST

/cluster/calculate

Prefer the synchronous endpoint and use this Batch Cluster endpoint for
long running problems only. The work flow is asynchronous:

send a POST request towards https://graphhopper.com/api/1/cluster/calculate?key=<your_key> and fetch the job_id.

poll the solution every 500ms until it gives status=finished. Do this with a GET request
towards https://graphhopper.com/api/1/cluster/solution/<job_id>?key=<your_key>.

请求参数

Authorization

API Key

在 query 添加参数

key

示例：

key: ********************

Body 参数application/json必填

示例

{
    "configuration": {
        "response_type": "json",
        "routing": {
            "profile": "car",
            "cost_per_second": 1,
            "cost_per_meter": 0
        },
        "clustering": {
            "num_clusters": 10,
            "max_quantity": 50,
            "min_quantity": 30
        }
    },
    "clusters": [
        {
            "name": "GraphHopper GmbH",
            "center": {
                "lon": 11.53941,
                "lat": 48.118434,
                "street_hint": "Lindenschmitstraße 52"
            },
            "min_quantity": 10,
            "max_quantity": 10
        }
    ],
    "customers": [
        {
            "id": "GraphHopper GmbH",
            "address": {
                "lon": 11.53941,
                "lat": 48.118434,
                "street_hint": "Lindenschmitstraße 52"
            },
            "quantity": 10
        }
    ]
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/cluster/calculate?key=%3Capi-key%3E' \
--header 'Content-Type: application/json' \
--data '{
    "configuration": {
        "response_type": "json",
        "routing": {
            "profile": "car",
            "cost_per_second": 1,
            "cost_per_meter": 0
        },
        "clustering": {
            "num_clusters": 10,
            "max_quantity": 50,
            "min_quantity": 30
        }
    },
    "clusters": [
        {
            "name": "GraphHopper GmbH",
            "center": {
                "lon": 11.53941,
                "lat": 48.118434,
                "street_hint": "Lindenschmitstraße 52"
            },
            "min_quantity": 10,
            "max_quantity": 10
        }
    ],
    "customers": [
        {
            "id": "GraphHopper GmbH",
            "address": {
                "lon": 11.53941,
                "lat": 48.118434,
                "street_hint": "Lindenschmitstraße 52"
            },
            "quantity": 10
        }
    ]
}'

返回响应

🟢200成功

application/json

A jobId you can use to retrieve your solution from the server - see solution endpoint.

Headers

Bodyapplication/json

示例

{
    "job_id": "44886560-b584-4da5-b245-768151dacd8f"
}

🟠400请求有误

🔴500服务器错误

修改于 2025-11-25 06:18:54

Solve a clustering problem

Retrieve solution of a clustering job