BatchSubmitRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/whoisgeni-us/json-schema/whoisgeni-us-batch-submit-request-schema.json",
  "title": "BatchSubmitRequest",
  "description": "Request body for submitting multiple domains for analysis.\n\nAttributes:\n    domains: List of domain names to analyze (1-50).",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/whoisgeni-us-openapi.json#/components/schemas/BatchSubmitRequest",
  "properties": {
    "domains": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "maxItems": 50,
      "minItems": 1,
      "title": "Domains"
    },
    "depth": {
      "type": "string",
      "enum": [
        "deep",
        "quick"
      ],
      "title": "Depth",
      "description": "Analysis depth, applied to every domain in the batch. 'deep' (default) queues full async analyses (202/207/422). 'quick' runs each domain through the inline fast path (same semantics as POST /analyze depth=quick) and is capped at 10 domains per batch (422 above) so the request stays under the edge timeout; it cannot be combined with force_refresh (400).",
      "default": "deep"
    },
    "force_refresh": {
      "type": "boolean",
      "title": "Force Refresh",
      "default": false
    },
    "callback_url": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2048,
          "pattern": "^https?://"
        },
        {
          "type": "null"
        }
      ],
      "title": "Callback Url",
      "description": "Optional URL to receive webhook POSTs when each analysis completes"
    },
    "output_schema": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Output Schema",
      "description": "Template ID for response projection (mutually exclusive with output_fields)"
    },
    "output_fields": {
      "anyOf": [
        {
          "$ref": "#/$defs/OutputFieldsSpec"
        },
        {
          "type": "null"
        }
      ],
      "description": "Inline field spec for response projection (mutually exclusive with output_schema)"
    }
  },
  "type": "object",
  "required": [
    "domains"
  ],
  "$defs": {
    "OutputFieldsSpec": {
      "properties": {
        "mode": {
          "type": "string",
          "enum": [
            "include",
            "exclude"
          ],
          "title": "Mode"
        },
        "fields": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "minItems": 1,
          "title": "Fields"
        }
      },
      "type": "object",
      "required": [
        "mode",
        "fields"
      ],
      "title": "OutputFieldsSpec",
      "description": "Inline field projection spec for response customization.\n\nSpecifies a mode (include or exclude) and a list of dot-notation field\npaths to apply as a filter on the scoring_result dict.\n\nAttributes:\n    mode: ``\"include\"`` to whitelist fields, ``\"exclude\"`` to blacklist.\n    fields: List of dot-notation field paths (min 1 required)."
    }
  }
}