BatchSubmitRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/geoapify/json-schema/geoapify-batch-submit-request-schema.json",
  "title": "BatchSubmitRequest",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/geoapify-batch-api-openapi.yml#/components/schemas/BatchSubmitRequest",
  "type": "object",
  "additionalProperties": true,
  "required": [
    "api",
    "inputs"
  ],
  "properties": {
    "api": {
      "type": "string",
      "enum": [
        "/v1/isoline",
        "/v1/routing",
        "/v1/places",
        "/v1/geometry",
        "/v1/geocode/search",
        "/v1/geocode/reverse",
        "/v1/mapmatching",
        "/v2/places",
        "/v2/place-info",
        "/v2/place-details",
        "/v1/ipinfo",
        "/v1/routeplanner",
        "/v1/routematrix",
        "/v1/boundaries/part-of",
        "/v1/boundaries/consists-of",
        "/v1/boundaries/near-by",
        "/v1/boundaries/parent-of"
      ],
      "description": "Geoapify API endpoint to execute for each batch input."
    },
    "params": {
      "type": "object",
      "additionalProperties": true,
      "description": "Request-level query parameters applied to all batch inputs."
    },
    "body": {
      "type": "object",
      "additionalProperties": true,
      "description": "Request-level body applied to all batch inputs."
    },
    "inputs": {
      "type": "array",
      "minItems": 1,
      "maxItems": 1000,
      "items": {
        "$ref": "#/$defs/BatchInput"
      }
    },
    "priority": {
      "type": "number",
      "minimum": 0.5,
      "maximum": 1,
      "default": 0.5,
      "description": "Processing priority and credit-cost factor. Use `0.5` to spend 50% of the normal credits when longer processing is acceptable, or `1` to spend the full credits for faster processing. Values between `0.5` and `1` balance the discount and processing speed."
    }
  },
  "$defs": {
    "BatchInput": {
      "type": "object",
      "additionalProperties": true,
      "anyOf": [
        {
          "required": [
            "params"
          ]
        },
        {
          "required": [
            "body"
          ]
        }
      ],
      "properties": {
        "id": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "number"
            }
          ],
          "description": "Optional caller-supplied input identifier returned with the result."
        },
        "params": {
          "type": "object",
          "additionalProperties": true,
          "description": "Optional input-specific query parameters."
        },
        "body": {
          "type": "object",
          "additionalProperties": true,
          "description": "Input-specific request body."
        }
      }
    }
  }
}