SearchBatchResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/s1-dev/main/json-schema/s1-dev-search-batch-response-schema.json",
  "title": "SearchBatchResponse",
  "x-generated": "2026-10-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/s1-dev-openapi.yml#/components/schemas/SearchBatchResponse",
  "type": "object",
  "required": [
    "results",
    "summary"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "success",
          "cost"
        ],
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "$ref": "#/$defs/SearchResponse"
          },
          "error": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "statusCode": {
                "type": "integer"
              }
            }
          },
          "cost": {
            "type": "integer",
            "minimum": 0
          }
        }
      }
    },
    "summary": {
      "type": "object",
      "required": [
        "total",
        "successful",
        "failed",
        "totalCost"
      ],
      "properties": {
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "successful": {
          "type": "integer",
          "minimum": 0
        },
        "failed": {
          "type": "integer",
          "minimum": 0
        },
        "totalCost": {
          "type": "integer",
          "minimum": 0
        }
      }
    }
  },
  "$defs": {
    "SearchParameters": {
      "type": "object",
      "properties": {
        "query": {
          "type": "string",
          "minLength": 1
        },
        "search_service": {
          "type": "string",
          "enum": [
            "google",
            "bing",
            "bingcn",
            "duckduckgo",
            "yahoo",
            "yandex",
            "youtube",
            "x",
            "reddit",
            "github",
            "arxiv",
            "wechat",
            "bilibili",
            "imdb",
            "wikipedia",
            "",
            "baidu",
            "360",
            "quark"
          ]
        },
        "max_results": {
          "type": "integer",
          "minimum": 1,
          "maximum": 50,
          "default": 5
        },
        "page": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100,
          "default": 1
        },
        "crawl_results": {
          "type": "integer",
          "minimum": 0,
          "maximum": 50,
          "default": 0
        },
        "image": {
          "type": "boolean",
          "default": false
        },
        "include_sites": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": []
        },
        "exclude_sites": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": []
        },
        "language": {
          "type": "string"
        },
        "time_range": {
          "type": "string",
          "enum": [
            "day",
            "week",
            "month",
            "year",
            ""
          ]
        }
      },
      "required": [
        "query"
      ],
      "additionalProperties": false
    },
    "SearchResponse": {
      "type": "object",
      "required": [
        "searchParameters",
        "results"
      ],
      "properties": {
        "searchParameters": {
          "$ref": "#/$defs/SearchParameters"
        },
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/SearchResult"
          }
        },
        "images": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    },
    "SearchResult": {
      "type": "object",
      "required": [
        "title",
        "link",
        "snippet"
      ],
      "properties": {
        "title": {
          "type": "string"
        },
        "link": {
          "type": "string",
          "format": "uri"
        },
        "snippet": {
          "type": "string"
        },
        "content": {
          "type": "string"
        },
        "published_date": {
          "type": "string",
          "description": "When the page was published, as ISO 8601: `YYYY-MM-DD` when only the day is known (web search engines), or `YYYY-MM-DDTHH:MM:SSZ` in UTC when the source carries a time (x, reddit, github, arxiv, youtube, bilibili, wechat, news feeds). Omitted when the source exposes no date, so treat it as optional per result."
        },
        "kind": {
          "type": "string",
          "enum": [
            "repo",
            "issue",
            "pr",
            "discussion"
          ],
          "description": "What a `github` result is: a repository, an issue, a pull request, or a discussion. Only present for `search_service: \"github\"`."
        },
        "stars": {
          "type": "integer",
          "description": "Stargazer count of a `github` repository result (`kind: \"repo\"`)."
        },
        "language": {
          "type": "string",
          "description": "Primary language of a `github` repository result (`kind: \"repo\"`). Omitted when GitHub reports none."
        },
        "num_comments": {
          "type": "integer",
          "description": "Comment count on a `github` issue, pull request or discussion, or on a `hackernews` thread (POST /news)."
        },
        "story_url": {
          "type": "string",
          "format": "uri",
          "description": "POST /news with `search_service: \"hackernews\"` only: the submitted article. `link` is the Hacker News discussion thread; `story_url` is empty for Ask HN / Show HN text posts."
        },
        "points": {
          "type": "integer",
          "description": "POST /news with `search_service: \"hackernews\"` only: upvotes on the thread."
        }
      },
      "additionalProperties": true
    }
  }
}