Microsoft Azure Azure Maps Route Service — Route

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure Azure Maps Route Service — Route
  description: 'Microsoft Azure Azure Maps Route Service — Route. 5 operations. Lead operation: Microsoft Azure Post Route
    Directions Batch Format. Self-contained Naftiko capability covering one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - Route
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: azure-maps-route-service-route
    baseUri: https://atlas.microsoft.com
    description: Microsoft Azure Azure Maps Route Service — Route business capability. Self-contained, no shared references.
    resources:
    - name: route-directions-batch-format
      path: /route/directions/batch/{format}
      operations:
      - name: microsoftazureroutepostroutedirectionsbatch
        method: POST
        description: Microsoft Azure Post Route Directions Batch Format
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeDirectionsBatchRequestBody
          in: body
          type: string
          description: The list of route directions queries/requests to process. The list can contain  a max of 700 queries
            for async and 100 queries for sync version and must contain
          required: true
    - name: route-directions-format
      path: /route/directions/{format}
      operations:
      - name: microsoftazureroutegetroutedirections
        method: GET
        description: Microsoft Azure Get Route Directions Format
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
          description: The Coordinates through which the route is calculated, delimited by a colon.  A minimum of two coordinates
            is required.  The first one is the origin and the las
          required: true
        - name: maxAlternatives
          in: query
          type: integer
          description: 'Number of desired alternative routes to be calculated. Default: 0, minimum: 0 and maximum: 5'
        - name: minDeviationDistance
          in: query
          type: integer
          description: All alternative routes returned will follow the reference route (see section POST Requests) from the
            origin point of the calculateRoute request for at least thi
        - name: minDeviationTime
          in: query
          type: integer
          description: All alternative routes returned will follow the reference route (see section POST Requests) from the
            origin point of the calculateRoute request for at least thi
        - name: language
          in: query
          type: string
          description: The language parameter determines the language of the guidance messages. Proper nouns (the names of
            streets, plazas, etc.) are returned in the specified  langua
      - name: microsoftazureroutepostroutedirections
        method: POST
        description: Microsoft Azure Post Route Directions Format
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
          description: The Coordinates through which the route is calculated. Needs two coordinates at least. Delimited by
            colon. First one is the origin and the last is the destinati
          required: true
        - name: maxAlternatives
          in: query
          type: integer
          description: 'Number of desired alternative routes to be calculated. Default: 0, minimum: 0 and maximum: 5'
        - name: minDeviationDistance
          in: query
          type: integer
          description: All alternative routes returned will follow the reference route (see section POST Requests) from the
            origin point of the calculateRoute request for at least thi
        - name: minDeviationTime
          in: query
          type: integer
          description: All alternative routes returned will follow the reference route (see section POST Requests) from the
            origin point of the calculateRoute request for at least thi
        - name: language
          in: query
          type: string
          description: The language parameter determines the language of the guidance messages. It does not affect proper
            nouns (the names of streets, plazas, etc.) It has no effect w
        - name: routeDirectionsRequestBody
          in: body
          type: string
          description: Used for reconstructing a route and for calculating zero or more alternative routes to this reference
            route.  The provided sequence of coordinates is used as in
          required: true
    - name: route-matrix-format
      path: /route/matrix/{format}
      operations:
      - name: microsoftazureroutepostroutematrix
        method: POST
        description: Microsoft Azure Post Route Matrix Format
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: waitForResults
          in: query
          type: boolean
          description: Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200
            response if the request is finished under 120 seconds. Oth
        - name: routeMatrixBody
          in: body
          type: string
          description: The matrix of origin and destination coordinates to compute the route distance, travel time and other
            summary for each cell of the matrix based on the input par
          required: true
    - name: route-range-format
      path: /route/range/{format}
      operations:
      - name: microsoftazureroutegetrouterange
        method: GET
        description: Microsoft Azure Get Route Range Format
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
          description: The Coordinate from which the range calculation should start.
          required: true
        - name: fuelBudgetInLiters
          in: query
          type: number
          description: Fuel budget in liters that determines maximal range which can be travelled using the specified Combustion
            Consumption Model.<br> When fuelBudgetInLiters is used
        - name: energyBudgetInkWh
          in: query
          type: number
          description: Electric energy budget in kilowatt hours (kWh) that determines maximal range which can be travelled
            using the specified Electric Consumption Model.<br> When ene
        - name: timeBudgetInSec
          in: query
          type: number
          description: 'Time budget in seconds that determines maximal range which can be travelled using driving time. The
            Consumption Model will only affect the range when routeType '
        - name: distanceBudgetInMeters
          in: query
          type: number
          description: Distance budget in meters that determines maximal range which can be travelled using driving distance.  The
            Consumption Model will only affect the range when ro
  exposes:
  - type: rest
    namespace: azure-maps-route-service-route-rest
    port: 8080
    description: REST adapter for Microsoft Azure Azure Maps Route Service — Route. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/route/directions/batch/{format}
      name: route-directions-batch-format
      description: REST surface for route-directions-batch-format.
      operations:
      - method: POST
        name: microsoftazureroutepostroutedirectionsbatch
        description: Microsoft Azure Post Route Directions Batch Format
        call: azure-maps-route-service-route.microsoftazureroutepostroutedirectionsbatch
        with:
          routeDirectionsBatchRequestBody: rest.routeDirectionsBatchRequestBody
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/route/directions/{format}
      name: route-directions-format
      description: REST surface for route-directions-format.
      operations:
      - method: GET
        name: microsoftazureroutegetroutedirections
        description: Microsoft Azure Get Route Directions Format
        call: azure-maps-route-service-route.microsoftazureroutegetroutedirections
        with:
          query: rest.query
          maxAlternatives: rest.maxAlternatives
          minDeviationDistance: rest.minDeviationDistance
          minDeviationTime: rest.minDeviationTime
          language: rest.language
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: microsoftazureroutepostroutedirections
        description: Microsoft Azure Post Route Directions Format
        call: azure-maps-route-service-route.microsoftazureroutepostroutedirections
        with:
          query: rest.query
          maxAlternatives: rest.maxAlternatives
          minDeviationDistance: rest.minDeviationDistance
          minDeviationTime: rest.minDeviationTime
          language: rest.language
          routeDirectionsRequestBody: rest.routeDirectionsRequestBody
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/route/matrix/{format}
      name: route-matrix-format
      description: REST surface for route-matrix-format.
      operations:
      - method: POST
        name: microsoftazureroutepostroutematrix
        description: Microsoft Azure Post Route Matrix Format
        call: azure-maps-route-service-route.microsoftazureroutepostroutematrix
        with:
          waitForResults: rest.waitForResults
          routeMatrixBody: rest.routeMatrixBody
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/route/range/{format}
      name: route-range-format
      description: REST surface for route-range-format.
      operations:
      - method: GET
        name: microsoftazureroutegetrouterange
        description: Microsoft Azure Get Route Range Format
        call: azure-maps-route-service-route.microsoftazureroutegetrouterange
        with:
          query: rest.query
          fuelBudgetInLiters: rest.fuelBudgetInLiters
          energyBudgetInkWh: rest.energyBudgetInkWh
          timeBudgetInSec: rest.timeBudgetInSec
          distanceBudgetInMeters: rest.distanceBudgetInMeters
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: azure-maps-route-service-route-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Azure Azure Maps Route Service — Route. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: microsoft-azure-post-route-directions
      description: Microsoft Azure Post Route Directions Batch Format
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-maps-route-service-route.microsoftazureroutepostroutedirectionsbatch
      with:
        routeDirectionsBatchRequestBody: tools.routeDirectionsBatchRequestBody
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-route-directions
      description: Microsoft Azure Get Route Directions Format
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-maps-route-service-route.microsoftazureroutegetroutedirections
      with:
        query: tools.query
        maxAlternatives: tools.maxAlternatives
        minDeviationDistance: tools.minDeviationDistance
        minDeviationTime: tools.minDeviationTime
        language: tools.language
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-post-route-directions-2
      description: Microsoft Azure Post Route Directions Format
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-maps-route-service-route.microsoftazureroutepostroutedirections
      with:
        query: tools.query
        maxAlternatives: tools.maxAlternatives
        minDeviationDistance: tools.minDeviationDistance
        minDeviationTime: tools.minDeviationTime
        language: tools.language
        routeDirectionsRequestBody: tools.routeDirectionsRequestBody
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-post-route-matrix
      description: Microsoft Azure Post Route Matrix Format
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-maps-route-service-route.microsoftazureroutepostroutematrix
      with:
        waitForResults: tools.waitForResults
        routeMatrixBody: tools.routeMatrixBody
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-route-range
      description: Microsoft Azure Get Route Range Format
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-maps-route-service-route.microsoftazureroutegetrouterange
      with:
        query: tools.query
        fuelBudgetInLiters: tools.fuelBudgetInLiters
        energyBudgetInkWh: tools.energyBudgetInkWh
        timeBudgetInSec: tools.timeBudgetInSec
        distanceBudgetInMeters: tools.distanceBudgetInMeters
      outputParameters:
      - type: object
        mapping: $.