action graphhopper_get_matrix {
  label: "GET Matrix Endpoint"
  description: "With this Matrix Endpoint you submit the points and parameters via URL parameters and is the most convenient\nas it works out-of-the-box in the browser. If possible you should\nprefer using the [POST Matrix Endpoint](#operation/postMatrix) that avoids problems with many locations\nand can also gzip the **request**. (Note, that all endpoints return gzipped responses).\n"
  provider: graphhopper
  method: GET
  path: "/matrix"
  encoding: json
  input: {
    type: "object"
    properties: {
      curbside: {
        type: "array"
        items: {
          type: "string"
          enum: ["any", "right", "left"]
        }
      }
      fail_fast: {
        type: "boolean"
      }
      from_curbside: {
        type: "array"
        items: {
          type: "string"
          enum: ["any", "right", "left"]
        }
      }
      from_point: {
        type: "array"
        items: {
          type: "string"
        }
      }
      from_point_hint: {
        type: "array"
        items: {
          type: "string"
        }
      }
      out_array: {
        type: "array"
        items: {
          type: "string"
        }
      }
      point: {
        type: "array"
        items: {
          type: "string"
        }
      }
      point_hint: {
        type: "array"
        items: {
          type: "string"
        }
      }
      snap_prevention: {
        type: "array"
        items: {
          type: "string"
        }
      }
      to_curbside: {
        type: "array"
        items: {
          type: "string"
          enum: ["any", "right", "left"]
        }
      }
      to_point: {
        type: "array"
        items: {
          type: "string"
        }
      }
      to_point_hint: {
        type: "array"
        items: {
          type: "string"
        }
      }
      turn_costs: {
        type: "boolean"
      }
      vehicle: {
        type: "string"
        enum: ["car", "bike", "foot", "hike", "mtb", "racingbike", "scooter", "truck", "small_truck"]
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      distances: {
        type: "array"
        description: "The distance matrix for the specified points in the same order as the time matrix. The distances are in meters. If `fail_fast=false` the matrix will contain `null` for connections that could not be found."
        items: {
          type: "array"
          items: {
            type: "number"
            format: "int64"
          }
        }
      }
      hints: {
        type: "array"
        description: "Optional. Additional response data."
        items: {
          type: "object"
          properties: {
            details: {
              type: "string"
              description: "Details of this hint"
            }
            invalid_from_points: {
              type: "array"
              description: "Optional. An array of from_point indices of points that could not be found. Will only be added if `fail_fast=false` and some `from_point`s were not found.`"
              items: {
                type: "number"
                format: "int32"
              }
            }
            invalid_to_points: {
              type: "array"
              description: "Optional. An array of to_point indices of points that could not be found. Will only be added if `fail_fast=false` and some `to_point`s were not found.`"
              items: {
                type: "number"
                format: "int32"
              }
            }
            message: {
              type: "string"
              description: "Short description of this hint"
            }
            point_pairs: {
              type: "array"
              description: "Optional. An array of two-element arrays representing the from/to_point indices of points for which no connection could be found. Will only be added if `fail_fast=false` and some connections were not found."
              items: {
                type: "array"
                items: {
                  type: "number"
                  format: "int32"
                }
              }
            }
          }
        }
      }
      info: {
        type: "object"
        description: "Additional information for your request"
        properties: {
          copyrights: {
            type: "array"
            description: "Attribution according to our documentation is necessary if no white-label option included."
            items: {
              type: "string"
            }
          }
          took: {
            type: "number"
            format: "double"
          }
        }
      }
      times: {
        type: "array"
        description: "The time matrix for the specified points in the order [[from1->to1, from1->to2, ...], [from2->to1, from2->to2, ...], ...]. The times are in seconds. If `fail_fast=false` the matrix will contain `null` for connections that could not be found."
        items: {
          type: "array"
          items: {
            type: "number"
            format: "int64"
          }
        }
      }
      weights: {
        type: "array"
        description: "The weight matrix for the specified points in the same order as the time matrix. The weights for different vehicles can have a different unit but the weights array is perfectly suited as input for Vehicle Routing Problems as it is currently faster to calculate. If `fail_fast=false` the matrix will contain `null` for connections that could not be found."
        items: {
          type: "array"
          items: {
            type: "number"
            format: "double"
          }
        }
      }
    }
  }
}