osrmroute-com Location Clustering API

openapi: 3.2.0
info:
  title: OSRMRoute Location Clustering API
  version: 1.1.0
  description: 'OSRMRoute — Maps, Routing, Truck Routing, Search, Road Data, Studio and integration APIs. Use `Authorization: Bearer ` unless an operation documents another flow. Legacy APIs also accept the key query parameter; New geospatial APIs, MCP and private map delivery require Bearer authentication. Mobile challenge/token endpoints use device attestation instead. Coordinates and units are documented per operation: GeoJSON uses longitude,latitude; some legacy and background-job inputs use latitude,longitude. Examples are illustrative, not guaranteed current results. Guides · Mobile Access · MCP · Postman collection.'
  contact:
    name: OSRMRoute Support
    url: https://osrmroute.com/contact
    email: support@osrmroute.com
  termsOfService: https://osrmroute.com/terms
servers:
- url: https://osrmroute.com
security:
- bearerAuth: []
- apiKeyQuery: []
tags:
- name: Location Clustering
paths:
  /api/1/cluster:
    post:
      tags:
      - Location Clustering
      summary: Location Clustering
      description: The Location Clustering API groups large sets of locations into balanced clusters by proximity. Give it hundreds of points and a target number of groups, and it partitions them into compact, well-separated clusters — perfect for splitting deliveries across drivers, defining service territories or pre-grouping stops before optimisation.
      operationId: post_location_clustering
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              examples:
                success:
                  summary: Illustrative abbreviated response; values vary with input and map data.
                  value:
                    status: finished
                    job_id: cluster-1234567890
                    processing_time: 0
                    no_clusters: 1
                    clusters:
                    - ids:
                      - s1
                      - s2
                      center:
                      - 40.385
                      - 49.855
                      size: 2
        '400':
          description: Error Codes (HTTP 400)
          content:
            application/json:
              examples:
                invalid:
                  value:
                    error: Provide a "customers" array with valid coordinates.
        '401':
          description: Error Codes (HTTP 401)
          content:
            application/json:
              examples:
                auth:
                  value:
                    error: Invalid API Key
        '402':
          description: Error Codes (HTTP 402)
          content:
            application/json:
              examples:
                balance:
                  value:
                    error: 'Insufficient balance: this request costs 1 credit and your balance is 0 credits. Top up your account to continue.'
        '403':
          description: Error Codes (HTTP 403)
          content:
            application/json:
              examples:
                plan:
                  value:
                    error: This API Key is disabled
        '429':
          description: Error Codes (HTTP 429)
          content:
            application/json:
              examples:
                rate:
                  value:
                    error: 'Rate limit exceeded: more than 60 requests per minute. Please slow down.'
        '500':
          description: Error Codes (HTTP 500)
          content:
            application/json:
              examples:
                upstream:
                  value:
                    error: Internal Server Error
      x-credit-cost: 3 credits
      x-request-limits:
      - 'customers: valid coordinates ≥ 1'
      - 1 ≤ clusters ≤ valid_customers.length
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                customers:
                  type: array
                  items: {}
                  description: Customer coordinates and weights to be clustered.
              required:
              - customers
            example:
              customers:
              - - 49.85
                - 40.37
              - - 49.86
                - 40.4
              - - 49.83
                - 40.39
              clusters: 2
components:
  securitySchemes:
    apiKeyQuery:
      type: apiKey
      in: query
      name: key
    bearerAuth:
      type: http
      scheme: bearer