{ "components": { "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" } }, "schemas": { "ProviderB91D37C29Ffe_Language-Input": { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, "ProviderB91D37C29Ffe_SearchCountry": { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, "ProviderB91D37C29Ffe_app__models__products__search__v1__images__SafeSearch": { "type": "string", "enum": [ "off", "strict" ], "title": "SafeSearch" }, "ProviderB91D37C29Ffe_Accept": { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, "ProviderB91D37C29Ffe_CacheControl": { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, "ResponseB91D37C29Ffe_ImageSearchApiResponse": { "properties": { "type": { "type": "string", "enum": [ "images" ], "const": "images", "title": "Type", "default": "images" }, "query": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__images__Query", "description": "Image search query string." }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ImageResult" }, "type": "array", "title": "Results", "description": "The list of image results for the given query." }, "extra": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__images__Extra", "description": "Additional information about the image search results." } }, "type": "object", "required": [ "query", "results", "extra" ], "title": "ImageSearchApiResponse" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__images__Query": { "properties": { "original": { "type": "string", "title": "Original", "description": "The original query that was requested." }, "altered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Altered", "description": "The altered query by the spellchecker. This is the query that is used to search." }, "spellcheck_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Spellcheck Off", "description": "Whether the spellchecker is enabled or disabled." }, "show_strict_warning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Show Strict Warning", "description": "The value is true if the lack of results is due to a strict safesearch setting. Adult content relevant to the query was found, but was blocked by safesearch." } }, "type": "object", "required": [ "original" ], "title": "Query" }, "ResponseB91D37C29Ffe_ImageResult": { "properties": { "type": { "type": "string", "title": "Type", "description": "The type of image search API result. The value is always image_result.", "default": "image_result" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "The title of the image." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "The original page URL where the image was found." }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "description": "The source domain where the image was found." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "The ISO date time when the page was last fetched. The format is YYYY-MM-DDTHH:MM:SSZ." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__images__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail for the image." }, "properties": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Properties" }, { "type": "null" } ], "description": "Metadata for the image." }, "meta_url": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__images__MetaUrl" }, { "type": "null" } ], "description": "Aggregated information on the URL associated with the image search result." }, "confidence": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high" ] }, { "type": "null" } ], "title": "Confidence", "description": "The confidence level for the image result." } }, "type": "object", "title": "ImageResult" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__images__Thumbnail": { "properties": { "src": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Src", "description": "The served URL of the image." }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Width", "description": "The width of the image." }, "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Height", "description": "The height of the image." } }, "type": "object", "title": "Thumbnail" }, "ResponseB91D37C29Ffe_Properties": { "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "The image URL." }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Placeholder", "description": "The lower resolution placeholder image URL." }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Width", "description": "The width of the image." }, "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Height", "description": "The height of the image." } }, "type": "object", "title": "Properties" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__images__MetaUrl": { "properties": { "scheme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheme", "description": "The protocol scheme extracted from the URL." }, "netloc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Netloc", "description": "The network location part extracted from the URL." }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hostname", "description": "The lowercased domain name extracted from the URL." }, "favicon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Favicon", "description": "The favicon used for the URL." }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Path", "description": "The hierarchical path of the URL useful as a display string." } }, "type": "object", "title": "MetaUrl" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__images__Extra": { "properties": { "might_be_offensive": { "type": "boolean", "title": "Might Be Offensive", "description": "Indicates whether the image search results might contain offensive content.", "default": false } }, "type": "object", "title": "Extra" }, "ProviderB91D37C29Ffe_app__models__general__SafeSearch": { "type": "string", "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch" }, "ProviderB91D37C29Ffe_SummarizerContextThresholdMode": { "type": "string", "enum": [ "disabled", "strict", "lenient", "balanced" ], "title": "SummarizerContextThresholdMode" }, "ProviderB91D37C29Ffe_Country": { "type": "string", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "Country" }, "ResponseB91D37C29Ffe_LLMContextAPIResponse": { "properties": { "grounding": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LLMContext", "default": { "generic": [], "map": [] } }, "sources": { "additionalProperties": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Source" }, "type": "object", "title": "Sources", "description": "Metadata for all referenced URLs, keyed by URL.", "default": {} } }, "type": "object", "title": "LLMContextAPIResponse", "description": "Response model for the LLM Context API (/v1/llm/context)." }, "ResponseB91D37C29Ffe_LLMContext": { "properties": { "generic": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LLMContextItem" }, "type": "array", "title": "Generic", "description": "Array of LLM context items with extracted web content.", "default": [] }, "poi": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LLMContextPOIItem" }, { "type": "null" } ], "description": "Point of interest data. When enable_local is enabled, the response may include POI data." }, "map": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LLMContextMapItem" }, "type": "array", "title": "Map", "description": "Map/place results. When enable_local is enabled, the response may include map data.", "default": [] } }, "type": "object", "title": "LLMContext", "description": "Container for all LLM context content by type." }, "ResponseB91D37C29Ffe_LLMContextItem": { "properties": { "url": { "type": "string", "title": "Url", "description": "The source URL.", "default": "" }, "title": { "type": "string", "title": "Title", "description": "The page title.", "default": "" }, "snippets": { "items": { "type": "string" }, "type": "array", "title": "Snippets", "description": "Extracted text chunks from the page that are picked for their relevance to the query.", "default": [] } }, "type": "object", "title": "LLMContextItem", "description": "A single LLM context item with URL, title, snippets, and optional last modified dates." }, "ResponseB91D37C29Ffe_LLMContextPOIItem": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The name of the point of interest." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "The URL of the point of interest." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "The title of the point of interest." }, "snippets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Snippets", "description": "The snippets about the point of interest." } }, "type": "object", "title": "LLMContextPOIItem", "description": "A point of interest item returned in the poi array for local recall queries." }, "ResponseB91D37C29Ffe_LLMContextMapItem": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The name of the place." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "The URL of the place." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "The title of the place." }, "snippets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Snippets", "description": "The snippets about the place." } }, "type": "object", "title": "LLMContextMapItem", "description": "A map/place item returned in the map array for local recall queries." }, "ResponseB91D37C29Ffe_Source": { "properties": { "title": { "type": "string", "title": "Title", "description": "The page title.", "default": "" }, "hostname": { "type": "string", "title": "Hostname", "description": "The source hostname.", "default": "" }, "age": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Age", "description": "The page’s date rendered four ways, in fixed positions: full date, YYYY-MM-DD, relative age, and an ISO 8601 timestamp. Empty when the page has no known date." }, "site_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Site Name", "description": "The site name (e.g. ‘Wikipedia’)." }, "favicon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Favicon", "description": "URL to the site’s favicon image." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_snakepit__models__search_api__specs__atomic__Thumbnail" }, { "type": "null" } ], "description": "Page thumbnail: src is the proxied URL (ready to serve); original is the raw upstream URL." }, "robotstxt_status": { "anyOf": [ { "type": "string", "enum": [ "allow", "disallow", "unknown" ] }, { "type": "null" } ], "title": "Robotstxt Status", "description": "Robots.txt status for the requested user-agent: allow, disallow, or unknown." }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snippet", "description": "The most query-relevant passage of the source page." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The page’s own description, independent of the query (unlike snippet). Requires enable_source_metadata." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "Unix seconds of the index’s last fetch of this page. Requires enable_source_metadata." } }, "type": "object", "title": "Source", "description": "Minimal metadata for a referenced source URL." }, "ResponseB91D37C29Ffe_snakepit__models__search_api__specs__atomic__Thumbnail": { "properties": { "src": { "type": "string", "title": "Src", "description": "The served URL of the picture thumbnail." }, "alt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alt", "description": "The alt text for the thumbnail image." }, "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Height", "description": "The height of the thumbnail." }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Width", "description": "The width of the thumbnail." }, "bg_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bg Color", "description": "The background color of the thumbnail." }, "original": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Original", "description": "The original URL of the image." }, "logo": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Logo", "description": "Whether the thumbnail is a logo." }, "duplicated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Duplicated", "description": "Whether the thumbnail is a duplicate." }, "theme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Theme", "description": "The theme of the thumbnail (e.g., light or dark)." } }, "type": "object", "required": [ "src" ], "title": "Thumbnail", "description": "Aggregated details representing a picture thumbnail." }, "ProviderB91D37C29Ffe_LLMContextParameters": { "properties": { "q": { "type": "string", "maxLength": 600, "minLength": 1, "title": "Q", "description": "The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query." }, "country": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_SearchCountry", "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries.", "default": "US" }, "search_lang": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_Language-Input", "description": "The search language preference. The 2 or more character language code for which the search results are provided.", "default": "en" }, "count": { "type": "integer", "maximum": 50, "minimum": 1, "title": "Count", "description": "The maximum number of search results considered to select the LLM context data. The default is 20 and the maximum is 50.", "default": 20 }, "safesearch": { "anyOf": [ { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_app__models__general__SafeSearch" }, { "type": "null" } ], "title": "Safe search", "description": "

Filters results for adult content. The following values are supported:

\n\n

When not set, no filtering is applied — except for local recall, which stays strict.

" }, "spellcheck": { "type": "boolean", "title": "Spellcheck", "description": "Whether to enable spellcheck on the query.", "default": true }, "maximum_number_of_urls": { "type": "integer", "maximum": 50, "minimum": 1, "title": "Maximum Number Of Urls", "description": "Maximum number of different URLs to include in LLM context.", "default": 20 }, "maximum_number_of_tokens": { "type": "integer", "maximum": 32768, "minimum": 1024, "title": "Maximum Number Of Tokens", "description": "Approximate maximum number of tokens to include in context. The default is 8192 and maximum is 32768.", "default": 8192 }, "maximum_number_of_snippets": { "type": "integer", "maximum": 256, "minimum": 1, "title": "Maximum Number Of Snippets", "description": "Maximum number of different snippets (or chunks of text) to include in LLM context. The default is 50 and maximum is 256.", "default": 50 }, "context_threshold_mode": { "anyOf": [ { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_SummarizerContextThresholdMode" }, { "type": "null" } ], "description": "The mode to use to determine the threshold for including content in context." }, "maximum_number_of_tokens_per_url": { "type": "integer", "maximum": 8192, "minimum": 512, "title": "Maximum Number Of Tokens Per Url", "description": "Maximum number of tokens to include per URL. The default is 4096 and maximum is 8192.", "default": 4096 }, "maximum_number_of_snippets_per_url": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Maximum Number Of Snippets Per Url", "description": "Maximum number of snippets to include per URL. The default is 50 and maximum is 100.", "default": 50 }, "goggles": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Goggles", "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles." }, "freshness": { "type": "string", "title": "Freshness", "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "default": "", "examples": [ "", "pm", "2022-04-01to2022-07-30" ] }, "enable_local": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Local", "description": "Whether to enable local recall. Not setting this value means auto-detect: local recall is used if a location is provided (X-Loc-Lat with X-Loc-Long, or X-Loc-City)." }, "enable_source_metadata": { "type": "boolean", "title": "Enable Source Metadata", "description": "Enable source metadata enrichment (site_name, favicon, thumbnail, description, fetched_content_timestamp) in the sources attribute of the response.", "default": false } }, "type": "object", "required": [ "q" ], "title": "LLMContextParameters" }, "ResponseB91D37C29Ffe_LocalDescriptionsSearchApiResponse": { "properties": { "type": { "type": "string", "enum": [ "local_descriptions" ], "const": "local_descriptions", "title": "Type", "default": "local_descriptions" }, "results": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationDescription" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Results", "description": "The list of location descriptions for the given location identifiers." } }, "type": "object", "title": "LocalDescriptionsSearchApiResponse" }, "ResponseB91D37C29Ffe_LocationDescription": { "properties": { "type": { "type": "string", "enum": [ "local_description" ], "const": "local_description", "title": "Type", "description": "The type of a location description. The value is always local_description.", "default": "local_description" }, "id": { "type": "string", "title": "Id", "description": "A temporary id of the location with this description." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "AI generated description of the location with the given id." } }, "type": "object", "required": [ "id" ], "title": "LocationDescription", "description": "AI generated description of a location result." }, "ProviderB91D37C29Ffe_MarketCodes": { "type": "string", "enum": [ "es-AR", "en-AU", "de-AT", "nl-BE", "fr-BE", "pt-BR", "en-CA", "fr-CA", "es-CL", "da-DK", "fi-FI", "fr-FR", "de-DE", "el-GR", "zh-HK", "en-IN", "en-ID", "it-IT", "ja-JP", "ko-KR", "en-MY", "es-MX", "nl-NL", "en-NZ", "no-NO", "zh-CN", "pl-PL", "en-PH", "ru-RU", "en-ZA", "es-ES", "sv-SE", "fr-CH", "de-CH", "zh-TW", "tr-TR", "en-GB", "en-US", "es-US" ], "title": "MarketCodes" }, "ProviderB91D37C29Ffe_MeasurementUnit": { "type": "string", "enum": [ "imperial", "metric" ], "title": "MeasurementUnit" }, "ResponseB91D37C29Ffe_LocalPlaceSearchApiResponse": { "properties": { "type": { "type": "string", "enum": [ "locations" ], "const": "locations", "title": "Type", "default": "locations" }, "query": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_snakepit__models__search_api__responses__local__v1__Query" }, { "type": "null" } ], "description": "The query object containing the original and potentially spell-corrected query." }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationResult" }, "type": "array" }, { "type": "null" } ], "title": "Results", "description": "The list of points of interest results for the given quer." }, "cities": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_CityResult" }, "type": "array" }, { "type": "null" } ], "title": "Cities", "description": "The list of city results for the given query." }, "countries": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_CountryResult" }, "type": "array" }, { "type": "null" } ], "title": "Countries", "description": "The list of country results for the given query." }, "regions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_RegionResult" }, "type": "array" }, { "type": "null" } ], "title": "Regions", "description": "The list of region results for the given query." }, "neighborhoods": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_NeighborhoodResult" }, "type": "array" }, { "type": "null" } ], "title": "Neighborhoods", "description": "The list of neighborhood results for the given query." }, "addresses": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_AddressResult" }, "type": "array" }, { "type": "null" } ], "title": "Addresses", "description": "The list of address results for the given query." }, "streets": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_AddressResult" }, "type": "array" }, { "type": "null" } ], "title": "Streets", "description": "The list of street results for the given query." }, "mixed": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ResultReference" }, "type": "array", "title": "Mixed", "description": "The list of mixed results for the given query.", "default": [] }, "location": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_snakepit__models__search_api__responses__local__v1__Location" }, { "type": "null" } ], "description": "Information about location resolved from either the coordinates of the location string." } }, "type": "object", "title": "LocalPlaceSearchApiResponse" }, "ResponseB91D37C29Ffe_snakepit__models__search_api__responses__local__v1__Query": { "properties": { "original": { "type": "string", "title": "Original", "description": "The original query that was requested." }, "altered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Altered", "description": "The altered query by the spellchecker. This is the query that is used to search." }, "spellcheck_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Spellcheck Off", "description": "Whether the spellchecker is enabled or disabled." }, "show_strict_warning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Show Strict Warning", "description": "The value is true if the lack of results is due to a strict safesearch setting. Adult content relevant to the query was found, but was blocked by safesearch." } }, "type": "object", "required": [ "original" ], "title": "Query" }, "ResponseB91D37C29Ffe_LocationResult": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the web page." }, "url": { "type": "string", "title": "Url", "description": "The URL where the page is served." }, "is_source_local": { "type": "boolean", "title": "Is Source Local", "description": "Whether the result is from a local source.", "default": false }, "is_source_both": { "type": "boolean", "title": "Is Source Both", "description": "Whether the result is from both local and global sources.", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A description for the web page.", "default": "" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "A date representing when the web page was last fetched." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "A language classification for the web page." }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the web page is family friendly.", "default": true }, "type": { "type": "string", "enum": [ "location_result" ], "const": "location_result", "title": "Type", "description": "Location result type identifier. The value is always location_result.", "default": "location_result" }, "provider_url": { "type": "string", "title": "Provider Url", "description": "The complete URL of the provider." }, "coordinates": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2 }, { "type": "null" } ], "title": "Coordinates", "description": "A list of coordinates associated with the location. This is a lat long represented as a floating point." }, "zoom_level": { "type": "integer", "title": "Zoom Level", "description": "The zoom level on the map.", "default": 7 }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail associated with the location." }, "postal_address": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_PostalAddress" }, { "type": "null" } ], "description": "The postal address associated with the location." }, "opening_hours": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_OpeningHours" }, { "type": "null" } ], "description": "The opening hours, if it is a business, associated with the location." }, "contact": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Contact" }, { "type": "null" } ], "description": "The contact of the business associated with the location." }, "price_range": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Price Range", "description": "A display string used to show the price classification for the business." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "The ratings of the business." }, "distance": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Unit" }, { "type": "null" } ], "description": "The distance of the location from the client." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider" }, "type": "array" }, { "type": "null" } ], "title": "Profiles", "description": "Profiles associated with the business." }, "reviews": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Reviews" }, { "type": "null" } ], "description": "Aggregated reviews from various sources relevant to the business." }, "pictures": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_PictureResults" }, { "type": "null" } ], "description": "A bunch of pictures associated with the business." }, "action": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Action" }, { "type": "null" } ], "description": "An action to be taken." }, "serves_cuisine": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Serves Cuisine", "description": "A list of cuisine categories served." }, "categories": { "items": { "type": "string" }, "type": "array", "title": "Categories", "description": "A list of categories.", "default": [] }, "icon_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Category", "description": "An icon category." }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone", "description": "IANA timezone identifier." }, "timezone_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Timezone Offset", "description": "The UTC offset of the timezone." }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id", "description": "A temporary id associated with this result, which can be used to retrieve extra information about the location. It remains valid for 8 hours." }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationWebResult" }, "type": "array" }, { "type": "null" } ], "title": "Results", "description": "Web results related to this location." } }, "type": "object", "required": [ "title", "url", "provider_url" ], "title": "LocationResult", "description": "A result that is location relevant." }, "ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile": { "properties": { "name": { "type": "string", "title": "Name", "description": "The name of the profile." }, "url": { "type": "string", "title": "Url", "description": "The original URL where the profile is available." }, "long_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long Name", "description": "The long name of the profile." }, "img": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Img", "description": "The served image URL representing the profile." } }, "type": "object", "required": [ "name", "url" ], "title": "Profile", "description": "A profile of an entity." }, "ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail": { "properties": { "src": { "type": "string", "title": "Src", "description": "The served URL of the picture thumbnail." }, "alt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alt", "description": "The alt text for the thumbnail image." }, "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Height", "description": "The height of the thumbnail." }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Width", "description": "The width of the thumbnail." }, "bg_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bg Color", "description": "The background color of the thumbnail." }, "original": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Original", "description": "The original URL of the image." }, "logo": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Logo", "description": "Whether the thumbnail is a logo." }, "duplicated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Duplicated", "description": "Whether the thumbnail is a duplicate." }, "theme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Theme", "description": "The theme of the thumbnail (e.g., light or dark)." } }, "type": "object", "required": [ "src" ], "title": "Thumbnail", "description": "Aggregated details representing a picture thumbnail." }, "ResponseB91D37C29Ffe_PostalAddress": { "properties": { "type": { "type": "string", "enum": [ "PostalAddress" ], "const": "PostalAddress", "title": "Type", "description": "The type identifying a postal address. The value is always PostalAddress.", "default": "PostalAddress" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "The country associated with the location." }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postalcode", "description": "The postal code associated with the location." }, "streetAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Streetaddress", "description": "The street address associated with the location." }, "addressRegion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressregion", "description": "The region associated with the location. This is usually a state." }, "addressLocality": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addresslocality", "description": "The address locality or subregion associated with the location." }, "displayAddress": { "type": "string", "title": "Displayaddress", "description": "The displayed address string." } }, "type": "object", "required": [ "displayAddress" ], "title": "PostalAddress", "description": "A model representing a postal address of a location." }, "ResponseB91D37C29Ffe_OpeningHours": { "properties": { "current_day": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_DayOpeningHours" }, "type": "array" }, { "type": "null" } ], "title": "Current Day", "description": "The current day opening hours. Can have two sets of opening hours." }, "days": { "anyOf": [ { "items": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_DayOpeningHours" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Days", "description": "The opening hours for the whole week." } }, "type": "object", "title": "OpeningHours", "description": "Opening hours of a business at a particular location." }, "ResponseB91D37C29Ffe_DayOpeningHours": { "properties": { "abbr_name": { "type": "string", "title": "Abbr Name", "description": "A short string representing the day of the week." }, "full_name": { "type": "string", "title": "Full Name", "description": "A full string representing the day of the week." }, "opens": { "type": "string", "title": "Opens", "description": "A 24 hr clock time string for the opening time of the business on a particular day." }, "closes": { "type": "string", "title": "Closes", "description": "A 24 hr clock time string for the closing time of the business on a particular day." } }, "type": "object", "required": [ "abbr_name", "full_name", "opens", "closes" ], "title": "DayOpeningHours", "description": "A model representing the opening hours for a particular day for a business at a particular location." }, "ResponseB91D37C29Ffe_Contact": { "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "The email address." }, "telephone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telephone", "description": "The telephone number." } }, "type": "object", "title": "Contact", "description": "A model representing contact information for an entity." }, "ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating": { "properties": { "ratingValue": { "type": "number", "minimum": 0, "title": "Ratingvalue", "description": "The current value of the rating." }, "bestRating": { "type": "number", "exclusiveMinimum": 0, "title": "Bestrating", "description": "Best rating received." }, "reviewCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reviewcount", "description": "The number of reviews associated with the rating." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "The profile associated with the rating." }, "is_tripadvisor": { "type": "boolean", "title": "Is Tripadvisor", "description": "Whether the rating is coming from Tripadvisor.", "default": false } }, "type": "object", "required": [ "ratingValue", "bestRating" ], "title": "Rating", "description": "The rating associated with an entity." }, "ResponseB91D37C29Ffe_Unit": { "properties": { "value": { "type": "number", "title": "Value", "description": "The quantity of the unit." }, "units": { "type": "string", "title": "Units", "description": "The name of the unit associated with the quantity." } }, "type": "object", "required": [ "value", "units" ], "title": "Unit", "description": "A model representing a unit of measurement." }, "ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider": { "properties": { "type": { "type": "string", "enum": [ "external" ], "const": "external", "title": "Type", "description": "The type representing the source of data. This is usually external.", "default": "external" }, "name": { "type": "string", "title": "Name", "description": "The name of the data provider. This can be a domain." }, "url": { "type": "string", "title": "Url", "description": "The URL where the information is coming from." }, "long_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long Name", "description": "The long name for the data provider." }, "img": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Img", "description": "The served URL for the image data." } }, "type": "object", "required": [ "name", "url" ], "title": "DataProvider", "description": "A model representing the data provider associated with the entity." }, "ResponseB91D37C29Ffe_Reviews": { "properties": { "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_TripadvisorReview" }, "type": "array", "title": "Results", "description": "A list of trip advisor reviews for the entity." }, "viewMoreUrl": { "type": "string", "title": "Viewmoreurl", "description": "A URL to a web page where more information on the result can be seen." }, "reviews_in_foreign_language": { "type": "boolean", "title": "Reviews In Foreign Language", "description": "Any reviews available in a foreign language." } }, "type": "object", "required": [ "results", "viewMoreUrl", "reviews_in_foreign_language" ], "title": "Reviews", "description": "The reviews associated with an entity." }, "ResponseB91D37C29Ffe_TripadvisorReview": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the review." }, "description": { "type": "string", "title": "Description", "description": "A description seen in the review." }, "date": { "type": "string", "title": "Date", "description": "The date when the review was published." }, "rating": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating", "description": "A rating given by the reviewer." }, "author": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Person", "description": "The author of the review." }, "review_url": { "type": "string", "title": "Review Url", "description": "A URL link to the page where the review can be found." }, "language": { "type": "string", "title": "Language", "description": "The language of the review." } }, "type": "object", "required": [ "title", "description", "date", "rating", "author", "review_url", "language" ], "title": "TripadvisorReview", "description": "A model representing a Tripadvisor review." }, "ResponseB91D37C29Ffe_Person": { "properties": { "type": { "type": "string", "enum": [ "person" ], "const": "person", "title": "Type", "description": "A type identifying a person. The value is always person.", "default": "person" }, "name": { "type": "string", "title": "Name", "description": "The name of the thing." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "A URL for the thing." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "Thumbnail associated with the thing." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "Email address of the person." } }, "type": "object", "required": [ "name" ], "title": "Person", "description": "A model describing a person entity." }, "ResponseB91D37C29Ffe_PictureResults": { "properties": { "viewMoreUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Viewmoreurl", "description": "A URL to view more pictures." }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, "type": "array", "title": "Results", "description": "A list of thumbnail results." } }, "type": "object", "required": [ "viewMoreUrl", "results" ], "title": "PictureResults", "description": "A model representing a list of pictures." }, "ResponseB91D37C29Ffe_Action": { "properties": { "type": { "type": "string", "title": "Type", "description": "The type representing the action." }, "url": { "type": "string", "title": "Url", "description": "A URL representing the action to be taken." } }, "type": "object", "required": [ "type", "url" ], "title": "Action", "description": "A model representing an action to be taken." }, "ResponseB91D37C29Ffe_LocationWebResult": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the web page." }, "url": { "type": "string", "title": "Url", "description": "The URL where the page is served." }, "is_source_local": { "type": "boolean", "title": "Is Source Local", "description": "Whether the result is from a local source.", "default": false }, "is_source_both": { "type": "boolean", "title": "Is Source Both", "description": "Whether the result is from both local and global sources.", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A description for the web page.", "default": "" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "A date representing when the web page was last fetched." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "A language classification for the web page." }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the web page is family friendly.", "default": true }, "meta_url": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__MetaUrl", "description": "Aggregated information about the URL." } }, "type": "object", "required": [ "title", "url", "meta_url" ], "title": "LocationWebResult", "description": "A model representing a web result related to a location." }, "ResponseB91D37C29Ffe_app__models__products__search__v1__shared__MetaUrl": { "properties": { "scheme": { "type": "string", "title": "Scheme", "description": "The protocol scheme extracted from the URL." }, "netloc": { "type": "string", "title": "Netloc", "description": "The network location part extracted from the URL." }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hostname", "description": "The lowercased domain name extracted from the URL." }, "favicon": { "type": "string", "title": "Favicon", "description": "The favicon used for the URL." }, "path": { "type": "string", "title": "Path", "description": "The hierarchical path of the URL useful as a display string." } }, "type": "object", "required": [ "scheme", "netloc", "favicon", "path" ], "title": "MetaUrl", "description": "Aggregated information about a URL." }, "ResponseB91D37C29Ffe_CityResult": { "properties": { "type": { "type": "string", "enum": [ "city" ], "const": "city", "title": "Type", "description": "City result type identifier. The value is always city.", "default": "city" }, "name": { "type": "string", "title": "Name", "description": "The name of the city." }, "country": { "type": "string", "title": "Country", "description": "The country of the city." }, "coordinates": { "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Coordinates", "description": "A pair of coordinates (lat, long) for the city." }, "thumbnail": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail", "description": "Primary image for the city." } }, "type": "object", "required": [ "name", "country", "coordinates", "thumbnail" ], "title": "CityResult", "description": "A result representing a city." }, "ResponseB91D37C29Ffe_CountryResult": { "properties": { "type": { "type": "string", "enum": [ "country" ], "const": "country", "title": "Type", "description": "Country result type identifier. The value is always country.", "default": "country" }, "name": { "type": "string", "title": "Name", "description": "The name of the country." }, "country": { "type": "string", "title": "Country", "description": "The country of the result." }, "coordinates": { "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Coordinates", "description": "A pair of coordinates (lat, long) for the country." }, "thumbnail": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail", "description": "Primary image for the country." } }, "type": "object", "required": [ "name", "country", "coordinates", "thumbnail" ], "title": "CountryResult", "description": "A result representing a country." }, "ResponseB91D37C29Ffe_RegionResult": { "properties": { "type": { "type": "string", "enum": [ "region" ], "const": "region", "title": "Type", "description": "Region result type identifier. The value is always region.", "default": "region" }, "name": { "type": "string", "title": "Name", "description": "The name of the region." }, "country": { "type": "string", "title": "Country", "description": "The country of the region." }, "coordinates": { "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Coordinates", "description": "A pair of coordinates (lat, long) for the region." }, "thumbnail": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail", "description": "Primary image for the region." } }, "type": "object", "required": [ "name", "country", "coordinates", "thumbnail" ], "title": "RegionResult", "description": "A result representing a region (e.g. a state or province)." }, "ResponseB91D37C29Ffe_NeighborhoodResult": { "properties": { "type": { "type": "string", "enum": [ "neighborhood" ], "const": "neighborhood", "title": "Type", "description": "Neighborhood result type identifier. The value is always neighborhood.", "default": "neighborhood" }, "name": { "type": "string", "title": "Name", "description": "The name of the neighborhood." }, "country": { "type": "string", "title": "Country", "description": "The country of the neighborhood." }, "coordinates": { "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Coordinates", "description": "A pair of coordinates (lat, long) for the neighborhood." }, "thumbnail": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail", "description": "Primary image for the neighborhood." } }, "type": "object", "required": [ "name", "country", "coordinates", "thumbnail" ], "title": "NeighborhoodResult", "description": "A result representing a neighborhood." }, "ResponseB91D37C29Ffe_AddressResult": { "properties": { "type": { "type": "string", "enum": [ "address", "street" ], "title": "Type", "description": "Result type identifier. address when the result refers to an explicit street + number, street when it refers to the street itself.", "default": "address" }, "name": { "type": "string", "title": "Name", "description": "The name of the address." }, "coordinates": { "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Coordinates", "description": "A pair of coordinates (lat, long) for the address." }, "pois": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationResult" }, "type": "array", "title": "Pois", "description": "POIs located at this address.", "default": [] }, "pois_nearby": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationResult" }, "type": "array", "title": "Pois Nearby", "description": "POIs located nearby this address.", "default": [] }, "zoom_level": { "type": "integer", "title": "Zoom Level", "description": "Suggested zoom level on the map.", "default": 15 }, "distance": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Unit" }, { "type": "null" } ], "description": "Distance from the user’s geolocation, if available." }, "postal_address": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_PostalAddress" }, { "type": "null" } ], "description": "Structured postal address." } }, "type": "object", "required": [ "name", "coordinates" ], "title": "AddressResult", "description": "A result representing a street address or a street." }, "ResponseB91D37C29Ffe_ResultReference": { "properties": { "type": { "type": "string", "title": "Type", "description": "The type of the result." }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Index", "description": "The 0th based index where the result should be placed." }, "all": { "type": "boolean", "title": "All", "description": "Whether to put all the results from the type at specific position.", "default": false } }, "type": "object", "required": [ "type" ], "title": "ResultReference", "description": "The ranking order of results on a search result page." }, "ResponseB91D37C29Ffe_snakepit__models__search_api__responses__local__v1__Location": { "properties": { "coordinates": { "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Coordinates", "description": "The latitude and longitude of the location." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The name of the location." }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "The two letter country code of the location." } }, "type": "object", "required": [ "coordinates" ], "title": "Location" }, "ResponseB91D37C29Ffe_LocalPoiSearchApiResponse": { "properties": { "type": { "type": "string", "enum": [ "local_pois" ], "const": "local_pois", "title": "Type", "default": "local_pois" }, "results": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationResult" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Results", "description": "The list of location results (POIs) for the given location identifiers." } }, "type": "object", "title": "LocalPoiSearchApiResponse" }, "ResponseB91D37C29Ffe_NewsSearchApiResponse": { "properties": { "type": { "type": "string", "enum": [ "news" ], "const": "news", "title": "Type", "default": "news" }, "query": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__news__Query", "description": "News search query string." }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__news__NewsResult" }, "type": "array", "title": "Results", "description": "The list of news results for the given query.", "default": [] } }, "type": "object", "required": [ "query" ], "title": "NewsSearchApiResponse" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__news__Query": { "properties": { "original": { "type": "string", "title": "Original", "description": "The original query that was requested." }, "altered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Altered", "description": "The altered query by the spellchecker. This is the query that is used to search if any." }, "cleaned": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cleaned", "description": "The cleaned normalized query by the spellchecker. This is the query that is used to search if any." }, "spellcheck_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Spellcheck Off", "description": "Whether the spellchecker is enabled or disabled." }, "show_strict_warning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Show Strict Warning", "description": "The value is true if the lack of results is due to a strict safesearch setting. Adult content relevant to the query was found, but was blocked by safesearch." }, "search_operators": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SearchOperators" }, { "type": "null" } ], "description": "Search operators applied to the query." } }, "type": "object", "required": [ "original" ], "title": "Query" }, "ResponseB91D37C29Ffe_SearchOperators": { "properties": { "applied": { "type": "boolean", "title": "Applied", "description": "Whether search operators were applied to the query.", "default": false }, "cleaned_query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cleaned Query", "description": "The query after search operators have been processed." }, "sites": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Sites", "description": "List of site domains extracted from site: operators." } }, "type": "object", "title": "SearchOperators" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__news__NewsResult": { "properties": { "type": { "type": "string", "enum": [ "news_result" ], "const": "news_result", "title": "Type", "description": "The type of news search API result. The value is always news_result.", "default": "news_result" }, "title": { "type": "string", "title": "Title", "description": "The title of the news article." }, "url": { "type": "string", "title": "Url", "description": "The source URL of the news article." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The description for the news article." }, "age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Age", "description": "A human-readable representation of the news article’s age. For example, 2 days ago." }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "The ISO date time when the page was last fetched. The format is YYYY-MM-DDTHH:MM:SSZ." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "meta_url": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__news__MetaUrl" }, { "type": "null" } ], "description": "Aggregated information on the URL associated with the news search result." }, "breaking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Breaking", "description": "Whether the result includes breaking news." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__news__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail for the news article." }, "extra_snippets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Extra Snippets", "description": "A list of extra alternate snippets for the news search result." }, "icons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_PostprocessedIcon" }, "type": "array" }, { "type": "null" } ], "title": "Icons", "description": "Icons associated with the news result." } }, "type": "object", "required": [ "title", "url" ], "title": "NewsResult" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__news__MetaUrl": { "properties": { "scheme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheme", "description": "The protocol scheme extracted from the URL." }, "netloc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Netloc", "description": "The network location part extracted from the URL." }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hostname", "description": "The lowercased domain name extracted from the URL." }, "favicon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Favicon", "description": "The favicon used for the URL." }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Path", "description": "The hierarchical path of the URL useful as a display string." } }, "type": "object", "title": "MetaUrl" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__news__Thumbnail": { "properties": { "src": { "type": "string", "title": "Src", "description": "The served URL of the thumbnail associated with the news article." }, "original": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Original", "description": "The original URL of the thumbnail associated with the news article." } }, "type": "object", "required": [ "src" ], "title": "Thumbnail" }, "ResponseB91D37C29Ffe_PostprocessedIcon": { "properties": { "href": { "type": "string", "title": "Href" }, "sizes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sizes" }, "rel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rel" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "ext": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ext" } }, "type": "object", "required": [ "href", "sizes", "rel", "type", "ext" ], "title": "PostprocessedIcon" }, "ProviderB91D37C29Ffe_NewsSearchParameters": { "properties": { "q": { "type": "string", "maxLength": 400, "minLength": 1, "title": "The user's search query term.", "description": "The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query." }, "search_lang": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_Language-Input", "description": "The search language preference. The 2 or more character language code for which the search results are provided.", "default": "en" }, "ui_lang": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_MarketCodes", "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.", "default": "en-US" }, "country": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_SearchCountry", "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide.", "default": "US" }, "safesearch": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_app__models__general__SafeSearch", "title": "Safe search", "description": "

Filters search results for adult content. The following values are supported:

\n", "default": "strict", "examples": [ "", "off", "moderate", "strict" ] }, "count": { "type": "integer", "maximum": 50, "minimum": 1, "title": "Count", "description": "The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "default": 20 }, "offset": { "type": "integer", "maximum": 9, "minimum": 0, "title": "Offset", "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "default": 0 }, "spellcheck": { "type": "boolean", "title": "Spellcheck", "description": "Whether to spell check the provided query. If the spellchecker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "default": true, "examples": [ "", true, false ] }, "freshness": { "type": "string", "title": "Freshness", "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "default": "", "examples": [ "", "pm", "2022-04-01to2022-07-30" ] }, "extra_snippets": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Extra Snippets", "description": "A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts." }, "goggles": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Goggles", "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles." }, "include_fetch_metadata": { "type": "boolean", "title": "Include Fetch Metadata", "description": "Include fetch metadata.", "default": false, "examples": [ "", true, false ] }, "operators": { "type": "boolean", "title": "Operators", "description": "Whether to apply search operators.", "default": true, "examples": [ "", true, false ] } }, "type": "object", "required": [ "q" ], "title": "NewsSearchParameters" }, "ResponseB91D37C29Ffe_SpellCheckSearchApiResponse": { "properties": { "type": { "type": "string", "enum": [ "spellcheck" ], "const": "spellcheck", "title": "Type", "default": "spellcheck" }, "query": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_OriginalQuery", "description": "Spellcheck search query string. Only the original query is returned." }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SpellCheckResult" }, "type": "array", "title": "Results", "description": "The list of spell-checked results for given query.", "default": [] } }, "type": "object", "required": [ "query" ], "title": "SpellCheckSearchApiResponse" }, "ResponseB91D37C29Ffe_OriginalQuery": { "properties": { "original": { "type": "string", "title": "Original", "description": "The original query that was requested." } }, "type": "object", "required": [ "original" ], "title": "OriginalQuery" }, "ResponseB91D37C29Ffe_SpellCheckResult": { "properties": { "query": { "type": "string", "title": "Query", "description": "The spellcheck-corrected query." } }, "type": "object", "required": [ "query" ], "title": "SpellCheckResult" }, "ResponseB91D37C29Ffe_SuggestSearchApiResponse": { "properties": { "type": { "type": "string", "enum": [ "suggest" ], "const": "suggest", "title": "Type", "default": "suggest" }, "query": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_OriginalQuery", "description": "Suggest search query string. Only the original query is returned." }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SuggestResult" }, "type": "array", "title": "Results", "description": "The list of suggestions for the given query.", "default": [] } }, "type": "object", "required": [ "query" ], "title": "SuggestSearchApiResponse" }, "ResponseB91D37C29Ffe_SuggestResult": { "properties": { "query": { "type": "string", "title": "Query", "description": "Suggested query completion." }, "type": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SuggestType" }, { "type": "null" } ], "description": "Kind of suggestion, currently query or entity. New kinds may be added, so treat an unrecognised value as a plain query suggestion." }, "is_entity": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Entity", "description": "Whether the suggested enriched query is an entity. Deprecated: use type instead." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "The suggested query enriched title." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The suggested query enriched description." }, "img": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Img", "description": "The suggested query enriched image URL." } }, "type": "object", "required": [ "query" ], "title": "SuggestResult" }, "ResponseB91D37C29Ffe_SuggestType": { "type": "string", "enum": [ "query", "entity", "calculator" ], "title": "SuggestType", "description": "

Kind tag on a rich suggestion entry.

\n

Open set: mixer emits these today, but we may add Rich Header verticals\nover time, so consumers must render an unrecognised value as plain text.

" }, "ResponseB91D37C29Ffe_VideoSearchApiResponse": { "properties": { "type": { "type": "string", "enum": [ "videos" ], "const": "videos", "title": "Type", "default": "videos" }, "query": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__Query", "description": "Video search query string." }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__VideoResult" }, "type": "array", "title": "Results", "description": "The list of video results for the given query.", "default": [] }, "extra": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__Extra", "description": "Additional information about the video search results." } }, "type": "object", "required": [ "query", "extra" ], "title": "VideoSearchApiResponse" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__videos__Query": { "properties": { "original": { "type": "string", "title": "Original", "description": "The original query that was requested." }, "altered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Altered", "description": "The altered query by the spellchecker. This is the query that is used to search if any." }, "cleaned": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cleaned", "description": "The cleaned normalized query by the spellchecker. This is the query that is used to search if any." }, "spellcheck_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Spellcheck Off", "description": "Whether the spellchecker is enabled or disabled." }, "show_strict_warning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Show Strict Warning", "description": "The value is true if the lack of results is due to a strict safesearch setting. Adult content relevant to the query was found, but was blocked by safesearch." }, "search_operators": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SearchOperators" }, { "type": "null" } ], "description": "Search operators applied to the query." } }, "type": "object", "required": [ "original" ], "title": "Query" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__videos__VideoResult": { "properties": { "type": { "type": "string", "enum": [ "video_result" ], "const": "video_result", "title": "Type", "description": "The type of video search API result. The value is always video_result.", "default": "video_result" }, "url": { "type": "string", "title": "Url", "description": "The source URL of the video." }, "title": { "type": "string", "title": "Title", "description": "The title of the video." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The description for the video." }, "age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Age", "description": "A human-readable representation of the video’s age. For example, 2 days ago." }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "The ISO date time when the page was last fetched. The format is YYYY-MM-DDTHH:MM:SSZ." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "video": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__VideoData" }, { "type": "null" } ], "description": "Metadata for the video." }, "meta_url": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__MetaUrl" }, { "type": "null" } ], "description": "Aggregated information on the URL associated with the video search result." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail for the video." } }, "type": "object", "required": [ "url", "title" ], "title": "VideoResult" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__videos__VideoData": { "properties": { "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duration", "description": "A time string representing the duration of the video." }, "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Views", "description": "The number of views of the video." }, "creator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Creator", "description": "The creator of the video." }, "publisher": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publisher", "description": "The publisher of the video." }, "requires_subscription": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Requires Subscription", "description": "Whether the video requires a subscription." }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "A list of tags relevant to the video." }, "author": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__Profile" }, { "type": "null" } ], "description": "A profile associated with the video." } }, "type": "object", "title": "VideoData" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__videos__Profile": { "properties": { "name": { "type": "string", "title": "Name", "description": "The name of the profile." }, "url": { "type": "string", "title": "Url", "description": "The original URL where the profile is available." }, "long_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long Name", "description": "The long name of the profile." }, "img": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Img", "description": "The served image URL representing the profile." } }, "type": "object", "required": [ "name", "url" ], "title": "Profile" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__videos__MetaUrl": { "properties": { "scheme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheme", "description": "The protocol scheme extracted from the URL." }, "netloc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Netloc", "description": "The network location part extracted from the URL." }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hostname", "description": "The lowercased domain name extracted from the URL." }, "favicon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Favicon", "description": "The favicon used for the URL." }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Path", "description": "The hierarchical path of the URL useful as a display string." } }, "type": "object", "title": "MetaUrl" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__videos__Thumbnail": { "properties": { "src": { "type": "string", "title": "Src", "description": "The served URL of the thumbnail associated with the video." }, "original": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Original", "description": "The original URL of the thumbnail associated with the video." } }, "type": "object", "required": [ "src" ], "title": "Thumbnail" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__videos__Extra": { "properties": { "might_be_offensive": { "type": "boolean", "title": "Might Be Offensive", "description": "Indicates whether the video search results might contain offensive content.", "default": false } }, "type": "object", "title": "Extra" }, "ProviderB91D37C29Ffe_VideoSearchParameters": { "properties": { "q": { "type": "string", "maxLength": 400, "minLength": 1, "title": "Q", "description": "The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query." }, "search_lang": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_Language-Input", "description": "The search language preference. The 2 or more character language code for which the search results are provided.", "default": "en" }, "ui_lang": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_MarketCodes", "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.", "default": "en-US" }, "country": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_SearchCountry", "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide.", "default": "US" }, "safesearch": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_app__models__general__SafeSearch", "title": "Safe search", "description": "

Filters search results for adult content. The following values are supported:

\n", "default": "moderate", "examples": [ "", "off", "moderate", "strict" ] }, "count": { "type": "integer", "maximum": 50, "minimum": 1, "title": "Count", "description": "The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "default": 20 }, "offset": { "type": "integer", "maximum": 9, "minimum": 0, "title": "Offset", "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "default": 0 }, "spellcheck": { "type": "boolean", "title": "Spellcheck", "description": "Whether to spell check the provided query. If the spellchecker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "default": true, "examples": [ "", true, false ] }, "freshness": { "type": "string", "title": "Freshness", "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "default": "", "examples": [ "", "pm", "2022-04-01to2022-07-30" ] }, "include_fetch_metadata": { "type": "boolean", "title": "Include Fetch Metadata", "description": "Include fetch metadata.", "default": false, "examples": [ "", true, false ] }, "operators": { "type": "boolean", "title": "Operators", "description": "Whether to apply search operators.", "default": true, "examples": [ "", true, false ] } }, "type": "object", "required": [ "q" ], "title": "VideoSearchParameters" }, "ResponseB91D37C29Ffe_RichHeaderResponse": { "properties": { "type": { "type": "string", "enum": [ "rich" ], "const": "rich", "title": "Type", "default": "rich" }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_RichResult" }, "type": "array", "title": "Results", "default": [] }, "response_callback_info": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ResponseCallbackInfo" }, { "type": "null" } ] } }, "type": "object", "title": "RichHeaderResponse" }, "ResponseB91D37C29Ffe_RichResult": { "properties": { "type": { "type": "string", "enum": [ "rich" ], "const": "rich", "title": "Type", "default": "rich" }, "subtype": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SearchAPIVertical" }, "provider": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_snakepit__models__mixer__specs__items__DataProvider" }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "calculator": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_CalculatorResult" }, { "type": "null" } ] }, "cryptocurrency": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_CryptocurrencyResult" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_CurrencyResult" }, { "type": "null" } ] }, "definitions": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_DefinitionsResult" }, { "type": "null" } ] }, "formula1": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Formula1Result" }, { "type": "null" } ] }, "news": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_TopStoriesNewsResult" }, { "type": "null" } ] }, "packagetracker": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_PackageTrackerResult" }, { "type": "null" } ] }, "american_football": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsResultAmericanFootball" }, { "type": "null" } ] }, "football": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsResultFootball" }, { "type": "null" } ] }, "baseball": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsResultBaseball" }, { "type": "null" } ] }, "basketball": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsResultBasketball" }, { "type": "null" } ] }, "ice_hockey": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsResultIceHockey" }, { "type": "null" } ] }, "cricket": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsResultCricket" }, { "type": "null" } ] }, "stock": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_StockResult" }, { "type": "null" } ] }, "unitconversion": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_UnitConversionResult" }, { "type": "null" } ] }, "unixtimestamp": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_UnixTimestampResult" }, { "type": "null" } ] }, "weather": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_WeatherResult" }, { "type": "null" } ] } }, "type": "object", "required": [ "subtype" ], "title": "RichResult" }, "ResponseB91D37C29Ffe_SearchAPIVertical": { "type": "string", "enum": [ "calculator", "cryptocurrency", "currency", "definitions", "formula1", "packagetracker", "sports", "stocks", "unitconversion", "unixtimestamp", "weather" ], "title": "SearchAPIVertical" }, "ResponseB91D37C29Ffe_snakepit__models__mixer__specs__items__DataProvider": { "properties": { "type": { "type": "string", "title": "Type", "default": "external" }, "name": { "type": "string", "title": "Name" }, "url": { "type": "string", "title": "Url" }, "long_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long Name" }, "img": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Img" } }, "type": "object", "required": [ "name", "url" ], "title": "DataProvider" }, "ResponseB91D37C29Ffe_CalculatorResult": { "properties": { "expression": { "type": "string", "title": "Expression" }, "answer": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Answer" } }, "type": "object", "required": [ "expression" ], "title": "CalculatorResult" }, "ResponseB91D37C29Ffe_CryptocurrencyResult": { "properties": { "intent_type": { "type": "string", "enum": [ "lookup", "conversion" ], "title": "Intent Type" }, "quote": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_snakepit__models__rich_header__results__cryptocurrencies__v1__Quote" }, "timeseries": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_CryptocurrencyResultTimeseries" }, "vs_currency": { "type": "string", "title": "Vs Currency" }, "vs_currencies": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_VsCurrency" }, "type": "array", "title": "Vs Currencies", "default": [] }, "top100_crypto": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_CryptocurrencyItem" }, "type": "array", "title": "Top100 Crypto", "default": [] }, "amount": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Amount" }, "currency": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_CurrencyForex" }, { "type": "null" } ] } }, "type": "object", "required": [ "intent_type", "quote", "timeseries", "vs_currency" ], "title": "CryptocurrencyResult" }, "ResponseB91D37C29Ffe_snakepit__models__rich_header__results__cryptocurrencies__v1__Quote": { "properties": { "id": { "type": "string", "title": "Id" }, "symbol": { "type": "string", "title": "Symbol" }, "name": { "type": "string", "title": "Name" }, "image": { "type": "string", "title": "Image" }, "current_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Price" }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap" }, "market_cap_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Market Cap Rank" }, "fully_diluted_valuation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Fully Diluted Valuation" }, "total_volume": { "type": "number", "title": "Total Volume" }, "high_24h": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High 24H" }, "low_24h": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low 24H" }, "price_change_24h": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Change 24H" }, "price_change_percentage_24h": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Change Percentage 24H" }, "market_cap_change_24h": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap Change 24H" }, "market_cap_change_percentage_24h": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap Change Percentage 24H" }, "circulating_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Circulating Supply" }, "total_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Supply" }, "max_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max Supply" }, "ath": { "type": "number", "title": "Ath" }, "ath_change_percentage": { "type": "number", "title": "Ath Change Percentage" }, "ath_date": { "type": "string", "title": "Ath Date" }, "atl": { "type": "number", "title": "Atl" }, "atl_change_percentage": { "type": "number", "title": "Atl Change Percentage" }, "atl_date": { "type": "string", "title": "Atl Date" }, "last_updated": { "type": "string", "title": "Last Updated" } }, "type": "object", "required": [ "id", "symbol", "name", "image", "current_price", "market_cap", "market_cap_rank", "total_volume", "high_24h", "low_24h", "price_change_24h", "price_change_percentage_24h", "market_cap_change_24h", "market_cap_change_percentage_24h", "ath", "ath_change_percentage", "ath_date", "atl", "atl_change_percentage", "atl_date", "last_updated" ], "title": "Quote" }, "ResponseB91D37C29Ffe_CryptocurrencyResultTimeseries": { "properties": { "time_range": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_TickerPlotTimeRange" }, "ts_price": { "items": { "prefixItems": [ { "type": "integer" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2 }, "type": "array", "title": "Ts Price" }, "ts_market_cap": { "items": { "prefixItems": [ { "type": "integer" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2 }, "type": "array", "title": "Ts Market Cap" }, "ts_volume": { "items": { "prefixItems": [ { "type": "integer" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2 }, "type": "array", "title": "Ts Volume" } }, "type": "object", "required": [ "time_range", "ts_price", "ts_market_cap", "ts_volume" ], "title": "CryptocurrencyResultTimeseries" }, "ResponseB91D37C29Ffe_TickerPlotTimeRange": { "type": "string", "enum": [ "1d", "5d", "7d", "1m", "3m", "6m", "ytd", "1y", "2y", "5y", "max" ], "title": "TickerPlotTimeRange" }, "ResponseB91D37C29Ffe_VsCurrency": { "properties": { "label": { "type": "string", "title": "Label" }, "value": { "type": "string", "title": "Value" } }, "type": "object", "required": [ "label", "value" ], "title": "VsCurrency", "description": "

These are currencies or cryptocurrencies that the cryptocurrency is\ncompared to. e.g. BTC, ETH, USD, EUR, etc.

" }, "ResponseB91D37C29Ffe_CryptocurrencyItem": { "properties": { "label": { "type": "string", "title": "Label" }, "value": { "type": "string", "title": "Value" }, "symbol": { "type": "string", "title": "Symbol" } }, "type": "object", "required": [ "label", "value", "symbol" ], "title": "CryptocurrencyItem" }, "ResponseB91D37C29Ffe_CurrencyForex": { "properties": { "full_name": { "type": "string", "title": "Full Name" }, "code": { "type": "string", "title": "Code" }, "decimals": { "type": "integer", "title": "Decimals" } }, "type": "object", "required": [ "full_name", "code", "decimals" ], "title": "CurrencyForex" }, "ResponseB91D37C29Ffe_CurrencyResult": { "properties": { "conversion": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Conversion" }, "timeseries": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Timeseries" }, "supported_currencies": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Currency" }, "type": "array", "title": "Supported Currencies", "default": [] } }, "type": "object", "required": [ "conversion", "timeseries" ], "title": "CurrencyResult" }, "ResponseB91D37C29Ffe_Conversion": { "properties": { "query": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_snakepit__models__rich_header__results__currencies__v1__Query" }, "info": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Info" }, "date": { "type": "string", "title": "Date" }, "result": { "type": "number", "title": "Result" }, "amount": { "type": "number", "title": "Amount" } }, "type": "object", "required": [ "query", "info", "date", "result", "amount" ], "title": "Conversion" }, "ResponseB91D37C29Ffe_snakepit__models__rich_header__results__currencies__v1__Query": { "properties": { "from_currency": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Currency" }, "to_currency": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Currency" }, "amount": { "type": "number", "title": "Amount" } }, "type": "object", "required": [ "from_currency", "to_currency", "amount" ], "title": "Query" }, "ResponseB91D37C29Ffe_Currency": { "properties": { "full_name": { "type": "string", "title": "Full Name" }, "code": { "type": "string", "title": "Code" }, "decimals": { "type": "integer", "title": "Decimals" } }, "type": "object", "required": [ "full_name", "code", "decimals" ], "title": "Currency" }, "ResponseB91D37C29Ffe_Info": { "properties": { "rate": { "type": "number", "title": "Rate" }, "timestamp": { "type": "integer", "title": "Timestamp" } }, "type": "object", "required": [ "rate", "timestamp" ], "title": "Info" }, "ResponseB91D37C29Ffe_Timeseries": { "properties": { "time_range": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_TickerPlotTimeRange" }, "ts_exchange_rate": { "items": { "prefixItems": [ { "type": "string" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2 }, "type": "array", "title": "Ts Exchange Rate", "default": [] } }, "type": "object", "required": [ "time_range" ], "title": "Timeseries" }, "ResponseB91D37C29Ffe_DefinitionsResult": { "properties": { "word": { "type": "string", "title": "Word" }, "language": { "type": "string", "title": "Language" }, "pronounciation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pronounciation" }, "definitions": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Definition" }, "type": "array", "title": "Definitions" }, "source_dict": { "type": "string", "title": "Source Dict" }, "attribution_text": { "type": "string", "title": "Attribution Text" }, "attribution_url": { "type": "string", "title": "Attribution Url" }, "audio_available": { "type": "boolean", "title": "Audio Available", "default": false } }, "type": "object", "required": [ "word", "language", "definitions", "source_dict", "attribution_text", "attribution_url" ], "title": "DefinitionsResult" }, "ResponseB91D37C29Ffe_Definition": { "properties": { "part_of_speech": { "type": "string", "title": "Part Of Speech" }, "definitions": { "items": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_DefinitionText" }, { "type": "string" } ] }, "type": "array", "title": "Definitions" } }, "type": "object", "required": [ "part_of_speech", "definitions" ], "title": "Definition" }, "ResponseB91D37C29Ffe_DefinitionText": { "properties": { "text": { "type": "string", "title": "Text" }, "example_uses": { "items": { "type": "string" }, "type": "array", "title": "Example Uses" }, "related_words": { "items": { "type": "string" }, "type": "array", "title": "Related Words" }, "labels": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_DefinitionLabel" }, "type": "array", "title": "Labels" } }, "type": "object", "required": [ "text", "example_uses", "related_words", "labels" ], "title": "DefinitionText" }, "ResponseB91D37C29Ffe_DefinitionLabel": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "title": "Type" } }, "type": "object", "required": [ "text", "type" ], "title": "DefinitionLabel" }, "ResponseB91D37C29Ffe_Formula1Result": { "properties": { "default_view": { "anyOf": [ { "type": "string", "enum": [ "schedule", "drivers", "constructors" ] }, { "type": "null" } ], "title": "Default View" }, "calendar": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Calendar" }, { "type": "null" } ] }, "next_race": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1RaceDetail" }, { "type": "null" } ] }, "previous_race": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1RaceDetail" }, { "type": "null" } ] }, "live_race": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1RaceDetail" }, { "type": "null" } ] }, "drivers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Standing" }, "type": "array" }, { "type": "null" } ], "title": "Drivers" }, "constructors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Standing" }, "type": "array" }, { "type": "null" } ], "title": "Constructors" } }, "type": "object", "title": "Formula1Result" }, "ResponseB91D37C29Ffe_F1Calendar": { "properties": { "races": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1RaceRef" }, "type": "array", "title": "Races", "default": [] }, "next_race": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Race" }, { "type": "null" } ] }, "previous_race": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Race" }, { "type": "null" } ] } }, "type": "object", "title": "F1Calendar" }, "ResponseB91D37C29Ffe_F1RaceRef": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" } }, "type": "object", "required": [ "id", "name" ], "title": "F1RaceRef" }, "ResponseB91D37C29Ffe_F1Race": { "properties": { "id": { "type": "integer", "title": "Id" }, "competition": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Competition" }, "circuit": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Circuit" }, "season": { "type": "integer", "title": "Season" }, "type": { "type": "string", "title": "Type" }, "laps": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Laps" }, { "type": "null" } ] }, "fastest_lap": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1FastestLap" }, { "type": "null" } ] }, "distance": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Distance" }, "date": { "type": "string", "title": "Date" }, "status": { "type": "string", "title": "Status" } }, "type": "object", "required": [ "id", "competition", "circuit", "season", "type", "date", "status" ], "title": "F1Race" }, "ResponseB91D37C29Ffe_F1Competition": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "location": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Location" } }, "type": "object", "required": [ "id", "name", "location" ], "title": "F1Competition" }, "ResponseB91D37C29Ffe_F1Location": { "properties": { "country": { "type": "string", "title": "Country" }, "city": { "type": "string", "title": "City" } }, "type": "object", "required": [ "country", "city" ], "title": "F1Location" }, "ResponseB91D37C29Ffe_F1Circuit": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "image": { "type": "string", "title": "Image" } }, "type": "object", "required": [ "id", "name", "image" ], "title": "F1Circuit" }, "ResponseB91D37C29Ffe_F1Laps": { "properties": { "current": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Current" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" } }, "type": "object", "title": "F1Laps" }, "ResponseB91D37C29Ffe_F1FastestLap": { "properties": { "driver": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1FastestLapDriver" }, { "type": "null" } ] }, "time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time" } }, "type": "object", "title": "F1FastestLap" }, "ResponseB91D37C29Ffe_F1FastestLapDriver": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" } }, "type": "object", "title": "F1FastestLapDriver" }, "ResponseB91D37C29Ffe_F1RaceDetail": { "properties": { "event": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Race" }, "standings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Standing" }, "type": "array" }, { "type": "null" } ], "title": "Standings" }, "qualifying": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Standing" }, "type": "array" }, { "type": "null" } ], "title": "Qualifying" }, "sprint_shootout": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Standing" }, "type": "array" }, { "type": "null" } ], "title": "Sprint Shootout" }, "sprint_event": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Race" }, { "type": "null" } ] }, "sprint_standings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Standing" }, "type": "array" }, { "type": "null" } ], "title": "Sprint Standings" }, "weekend_events": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1WeekendEvent" }, "type": "array" }, { "type": "null" } ], "title": "Weekend Events" } }, "type": "object", "required": [ "event" ], "title": "F1RaceDetail" }, "ResponseB91D37C29Ffe_F1Standing": { "properties": { "position": { "type": "integer", "title": "Position" }, "driver": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Driver" }, { "type": "null" } ] }, "team": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_F1Team" }, { "type": "null" } ] }, "points": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Points" }, "wins": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wins" }, "behind": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Behind" }, "season": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Season" }, "time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time" }, "laps": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Laps" }, "grid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grid" }, "gap": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gap" } }, "type": "object", "required": [ "position" ], "title": "F1Standing" }, "ResponseB91D37C29Ffe_F1Driver": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "abbr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Abbr" }, "number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Number" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image" } }, "type": "object", "required": [ "id", "name" ], "title": "F1Driver" }, "ResponseB91D37C29Ffe_F1Team": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logo" } }, "type": "object", "required": [ "id", "name" ], "title": "F1Team" }, "ResponseB91D37C29Ffe_F1WeekendEvent": { "properties": { "type": { "type": "string", "title": "Type" }, "date": { "type": "string", "title": "Date" }, "status": { "type": "string", "title": "Status" } }, "type": "object", "required": [ "type", "date", "status" ], "title": "F1WeekendEvent" }, "ResponseB91D37C29Ffe_TopStoriesNewsResult": { "properties": { "is_topical": { "type": "boolean", "title": "Is Topical" }, "topic_id": { "type": "integer", "title": "Topic Id" }, "topics": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Topic" }, "type": "array", "title": "Topics", "default": [] }, "articles": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_TopStoryNewsArticle" }, "type": "array", "title": "Articles", "default": [] } }, "type": "object", "required": [ "is_topical", "topic_id" ], "title": "TopStoriesNewsResult" }, "ResponseB91D37C29Ffe_Topic": { "properties": { "index": { "type": "integer", "title": "Index" }, "title": { "type": "string", "title": "Title" }, "score": { "type": "number", "title": "Score" }, "query": { "type": "string", "title": "Query" } }, "type": "object", "required": [ "index", "title", "score", "query" ], "title": "Topic" }, "ResponseB91D37C29Ffe_TopStoryNewsArticle": { "properties": { "title": { "type": "string", "title": "Title" }, "img": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Img" }, "img_small": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Img Small" }, "url": { "type": "string", "title": "Url" }, "meta_url": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_snakepit__models__mixer__specs__atomic__MetaUrl" }, "publisher_name": { "type": "string", "title": "Publisher Name" }, "publish_time": { "type": "integer", "title": "Publish Time" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age" }, "is_live": { "type": "boolean", "title": "Is Live", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "extra_snippets": { "items": { "type": "string" }, "type": "array", "title": "Extra Snippets", "default": [] }, "bo_debug": { "type": "object", "title": "Bo Debug", "default": {} } }, "type": "object", "required": [ "title", "url", "meta_url", "publisher_name", "publish_time" ], "title": "TopStoryNewsArticle" }, "ResponseB91D37C29Ffe_snakepit__models__mixer__specs__atomic__MetaUrl": { "properties": { "scheme": { "type": "string", "title": "Scheme" }, "netloc": { "type": "string", "title": "Netloc" }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hostname" }, "favicon": { "type": "string", "title": "Favicon" }, "path": { "type": "string", "title": "Path" } }, "type": "object", "required": [ "scheme", "netloc", "favicon", "path" ], "title": "MetaUrl" }, "ResponseB91D37C29Ffe_PackageTrackerResult": { "properties": { "matched": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_TrackingNumber" }, "type": "array", "title": "Matched", "default": [] } }, "type": "object", "title": "PackageTrackerResult" }, "ResponseB91D37C29Ffe_TrackingNumber": { "properties": { "tracking_number": { "type": "string", "title": "Tracking Number" }, "tracking_url": { "type": "string", "title": "Tracking Url" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "courier": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Courier" } }, "type": "object", "required": [ "tracking_number", "tracking_url", "courier" ], "title": "TrackingNumber" }, "ResponseB91D37C29Ffe_Courier": { "properties": { "name": { "type": "string", "title": "Name" }, "service": { "type": "string", "title": "Service" }, "code": { "type": "string", "title": "Code" }, "domain": { "type": "string", "title": "Domain" } }, "type": "object", "required": [ "name", "service", "code", "domain" ], "title": "Courier" }, "ResponseB91D37C29Ffe_SportsResultAmericanFootball": { "properties": { "sport": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsType", "default": "american_football" }, "type": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsDataType" }, "view": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsView" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballContentLeagueGames" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballContentLeagueStandings" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballContentTeamGames" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballContentTeamStandings" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballContentFixture" } ], "title": "Content" } }, "type": "object", "required": [ "type", "view", "content" ], "title": "SportsResultAmericanFootball" }, "ResponseB91D37C29Ffe_SportsType": { "type": "string", "enum": [ "basketball", "baseball", "football", "american_football", "formula_1", "ice_hockey", "rugby", "tennis", "golf", "cricket" ], "title": "SportsType" }, "ResponseB91D37C29Ffe_SportsDataType": { "type": "string", "enum": [ "league", "team", "fixture" ], "title": "SportsDataType" }, "ResponseB91D37C29Ffe_SportsView": { "type": "string", "enum": [ "games", "standings", "fixture", "bracket" ], "title": "SportsView" }, "ResponseB91D37C29Ffe_SportsAmericanFootballContentLeagueGames": { "properties": { "type": { "type": "string", "enum": [ "league_games" ], "const": "league_games", "title": "Type", "default": "league_games" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "game_times": { "items": { "type": "integer" }, "type": "array", "title": "Game Times" }, "game_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Time" }, "date": { "type": "string", "title": "Date" }, "date_kind": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsDateKind" }, "games": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureAmericanFootball" }, "type": "array", "title": "Games" } }, "type": "object", "required": [ "league", "game_times", "date", "date_kind", "games" ], "title": "SportsAmericanFootballContentLeagueGames" }, "ResponseB91D37C29Ffe_SportsLeague": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Id" }, "name": { "type": "string", "title": "Name" }, "logo": { "type": "string", "title": "Logo" }, "season": { "type": "string", "title": "Season" }, "round": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Round" }, "has_standings": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Standings" } }, "type": "object", "required": [ "id", "name", "logo", "season" ], "title": "SportsLeague" }, "ResponseB91D37C29Ffe_SportsDateKind": { "type": "string", "enum": [ "today", "season_end", "season_start", "explicit" ], "title": "SportsDateKind" }, "ResponseB91D37C29Ffe_SportsFixtureAmericanFootball": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "teams": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureTeams" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "start_time": { "type": "integer", "title": "Start Time" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballFixtureStatus" }, { "type": "null" } ] }, "video": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureVideo" }, { "type": "null" } ] }, "score_table": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballScoreTable" }, { "type": "null" } ] }, "phase": { "type": "string", "title": "Phase" } }, "type": "object", "required": [ "id", "teams", "start_time", "phase" ], "title": "SportsFixtureAmericanFootball" }, "ResponseB91D37C29Ffe_SportsFixtureTeams": { "properties": { "home": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "away": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" } }, "type": "object", "required": [ "home", "away" ], "title": "SportsFixtureTeams" }, "ResponseB91D37C29Ffe_SportsTeam": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location" }, "name": { "type": "string", "title": "Name" }, "logo": { "type": "string", "title": "Logo" } }, "type": "object", "required": [ "name", "logo" ], "title": "SportsTeam" }, "ResponseB91D37C29Ffe_SportsFixtureScore": { "properties": { "home": { "type": "integer", "title": "Home" }, "away": { "type": "integer", "title": "Away" } }, "type": "object", "required": [ "home", "away" ], "title": "SportsFixtureScore" }, "ResponseB91D37C29Ffe_SportsAmericanFootballFixtureStatus": { "properties": { "code": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballFixtureStatusCode" }, { "type": "null" } ] }, "elapsed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Elapsed" } }, "type": "object", "title": "SportsAmericanFootballFixtureStatus" }, "ResponseB91D37C29Ffe_SportsAmericanFootballFixtureStatusCode": { "type": "string", "enum": [ "FT", "AET", "Q1", "Q2", "Q3", "Q4", "NS", "POST", "CANC", "INT", "DEL", "LIVE", "FFA", "FFH", "FFB" ], "title": "SportsAmericanFootballFixtureStatusCode" }, "ResponseB91D37C29Ffe_SportsFixtureVideo": { "properties": { "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duration" }, "url": { "type": "string", "title": "Url" }, "thumbnail": { "type": "string", "title": "Thumbnail" }, "type": { "type": "string", "enum": [ "video", "story" ], "title": "Type", "default": "video" } }, "type": "object", "required": [ "url", "thumbnail" ], "title": "SportsFixtureVideo" }, "ResponseB91D37C29Ffe_SportsAmericanFootballScoreTable": { "properties": { "q1": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "q2": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "q3": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "q4": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "ot": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] } }, "type": "object", "title": "SportsAmericanFootballScoreTable" }, "ResponseB91D37C29Ffe_SportsAmericanFootballContentLeagueStandings": { "properties": { "type": { "type": "string", "enum": [ "league_standings" ], "const": "league_standings", "title": "Type", "default": "league_standings" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "group_standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballStandingsGroup" }, "type": "array", "title": "Group Standings" }, "default_group": { "type": "integer", "title": "Default Group" } }, "type": "object", "required": [ "league", "group_standings", "default_group" ], "title": "SportsAmericanFootballContentLeagueStandings" }, "ResponseB91D37C29Ffe_SportsAmericanFootballStandingsGroup": { "properties": { "group_name": { "type": "string", "title": "Group Name" }, "standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballStandingsDivision" }, "type": "array", "title": "Standings" } }, "type": "object", "required": [ "group_name", "standings" ], "title": "SportsAmericanFootballStandingsGroup" }, "ResponseB91D37C29Ffe_SportsAmericanFootballStandingsDivision": { "properties": { "name": { "type": "string", "title": "Name" }, "standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballStanding" }, "type": "array", "title": "Standings" } }, "type": "object", "required": [ "name", "standings" ], "title": "SportsAmericanFootballStandingsDivision" }, "ResponseB91D37C29Ffe_SportsAmericanFootballStanding": { "properties": { "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "division_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Division Rank" }, "division_seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Division Seed" }, "conference_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Conference Rank" }, "conference_seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Conference Seed" }, "matches_won": { "type": "integer", "title": "Matches Won" }, "matches_drawn": { "type": "integer", "title": "Matches Drawn" }, "matches_lost": { "type": "integer", "title": "Matches Lost" }, "matches_won_percent": { "type": "string", "title": "Matches Won Percent" }, "points_for": { "type": "integer", "title": "Points For" }, "points_against": { "type": "integer", "title": "Points Against" }, "games_behind": { "type": "string", "title": "Games Behind" } }, "type": "object", "required": [ "team", "matches_won", "matches_drawn", "matches_lost", "matches_won_percent", "points_for", "points_against", "games_behind" ], "title": "SportsAmericanFootballStanding" }, "ResponseB91D37C29Ffe_SportsAmericanFootballContentTeamGames": { "properties": { "type": { "type": "string", "enum": [ "team_games" ], "const": "team_games", "title": "Type", "default": "team_games" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "games": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureAmericanFootball" }, "type": "array", "title": "Games" }, "competitions": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCompetition" }, "type": "array", "title": "Competitions" } }, "type": "object", "required": [ "league", "team", "games", "competitions" ], "title": "SportsAmericanFootballContentTeamGames" }, "ResponseB91D37C29Ffe_SportsCompetition": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Id" }, "name": { "type": "string", "title": "Name" }, "season": { "type": "string", "title": "Season" } }, "type": "object", "required": [ "id", "name", "season" ], "title": "SportsCompetition" }, "ResponseB91D37C29Ffe_SportsAmericanFootballContentTeamStandings": { "properties": { "type": { "type": "string", "enum": [ "team_standings" ], "const": "team_standings", "title": "Type", "default": "team_standings" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "group_standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballStandingsGroup" }, "type": "array", "title": "Group Standings" }, "default_group": { "type": "integer", "title": "Default Group" } }, "type": "object", "required": [ "league", "team", "group_standings", "default_group" ], "title": "SportsAmericanFootballContentTeamStandings" }, "ResponseB91D37C29Ffe_SportsAmericanFootballContentFixture": { "properties": { "type": { "type": "string", "enum": [ "fixture" ], "const": "fixture", "title": "Type", "default": "fixture" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "start_time": { "type": "integer", "title": "Start Time" }, "teams": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureTeams" }, "status": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballFixtureStatus" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "score_table": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballScoreTable" }, "statistics": { "type": "object", "title": "Statistics" }, "phase": { "type": "string", "title": "Phase" }, "event_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Title" }, "week": { "type": "integer", "title": "Week" }, "bulletins": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsAmericanFootballFixtureBulletin" }, "type": "array" }, { "type": "null" } ], "title": "Bulletins" } }, "type": "object", "required": [ "league", "id", "start_time", "teams", "status", "score_table", "statistics", "phase", "week" ], "title": "SportsAmericanFootballContentFixture" }, "ResponseB91D37C29Ffe_SportsAmericanFootballFixtureBulletin": { "properties": { "text": { "type": "string", "title": "Text" } }, "type": "object", "required": [ "text" ], "title": "SportsAmericanFootballFixtureBulletin" }, "ResponseB91D37C29Ffe_SportsResultFootball": { "properties": { "sport": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsType", "default": "football" }, "type": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsDataType" }, "view": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsView" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballContentFixture" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballContentLeagueGames" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballContentTeamStandings" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballContentLeagueStandings" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballContentTeamGames" } ], "title": "Content" } }, "type": "object", "required": [ "type", "view", "content" ], "title": "SportsResultFootball" }, "ResponseB91D37C29Ffe_SportsFootballContentFixture": { "properties": { "type": { "type": "string", "enum": [ "fixture" ], "const": "fixture", "title": "Type", "default": "fixture" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "start_time": { "type": "integer", "title": "Start Time" }, "teams": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureTeams" }, "status": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballFixtureStatus" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "ps_score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "statistics": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsStatistic" }, "type": "array" }, { "type": "null" } ], "title": "Statistics" }, "events": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballFixtureEvent" }, "type": "array" }, { "type": "null" } ], "title": "Events" }, "lineups": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballLineups" }, { "type": "null" } ] }, "aggregate_score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureAggregateScore" }, { "type": "null" } ] } }, "type": "object", "required": [ "league", "id", "start_time", "teams", "status" ], "title": "SportsFootballContentFixture" }, "ResponseB91D37C29Ffe_SportsFootballFixtureStatus": { "properties": { "code": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballFixtureStatusCode" }, { "type": "null" } ] }, "elapsed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Elapsed" }, "extra": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Extra" } }, "type": "object", "title": "SportsFootballFixtureStatus" }, "ResponseB91D37C29Ffe_SportsFootballFixtureStatusCode": { "type": "string", "enum": [ "AET", "BT", "CANC", "ET", "FT", "1H", "2H", "HT", "LIVE", "NS", "P", "PEN", "PST", "SUSP", "TBD" ], "title": "SportsFootballFixtureStatusCode" }, "ResponseB91D37C29Ffe_SportsStatistic": { "properties": { "name": { "type": "string", "title": "Name" }, "home": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Home" }, "away": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Away" } }, "type": "object", "required": [ "name" ], "title": "SportsStatistic" }, "ResponseB91D37C29Ffe_SportsFootballFixtureEvent": { "properties": { "team_id": { "type": "integer", "title": "Team Id" }, "type": { "type": "string", "title": "Type" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail" }, "player_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Player Name" }, "assist_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assist Name" }, "elapsed": { "type": "integer", "title": "Elapsed" }, "extra": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Extra" } }, "type": "object", "required": [ "team_id", "type", "elapsed" ], "title": "SportsFootballFixtureEvent" }, "ResponseB91D37C29Ffe_SportsFootballLineups": { "properties": { "home": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballLineup" }, "away": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballLineup" } }, "type": "object", "required": [ "home", "away" ], "title": "SportsFootballLineups" }, "ResponseB91D37C29Ffe_SportsFootballLineup": { "properties": { "formation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Formation" }, "startXI": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballPlayer" }, "type": "array", "title": "Startxi" }, "substitutes": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballPlayer" }, "type": "array", "title": "Substitutes" }, "coach": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballCoach" } }, "type": "object", "required": [ "startXI", "substitutes", "coach" ], "title": "SportsFootballLineup" }, "ResponseB91D37C29Ffe_SportsFootballPlayer": { "properties": { "name": { "type": "string", "title": "Name" }, "number": { "type": "integer", "title": "Number" }, "pos": { "type": "string", "title": "Pos" }, "grid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grid" }, "photo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Photo" } }, "type": "object", "required": [ "name", "number", "pos" ], "title": "SportsFootballPlayer" }, "ResponseB91D37C29Ffe_SportsFootballCoach": { "properties": { "name": { "type": "string", "title": "Name" }, "photo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Photo" } }, "type": "object", "required": [ "name" ], "title": "SportsFootballCoach" }, "ResponseB91D37C29Ffe_SportsFixtureAggregateScore": { "properties": { "scores": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Scores" } }, "type": "object", "required": [ "scores" ], "title": "SportsFixtureAggregateScore" }, "ResponseB91D37C29Ffe_SportsFootballContentLeagueGames": { "properties": { "type": { "type": "string", "enum": [ "league_games" ], "const": "league_games", "title": "Type", "default": "league_games" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "game_times": { "items": { "type": "integer" }, "type": "array", "title": "Game Times" }, "game_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Time" }, "date": { "type": "string", "title": "Date" }, "date_kind": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsDateKind" }, "games": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureFootball" }, "type": "array", "title": "Games" }, "group_standings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballStandingsGroup" }, "type": "array" }, { "type": "null" } ], "title": "Group Standings" }, "structure": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Structure" } }, "type": "object", "required": [ "league", "game_times", "date", "date_kind", "games" ], "title": "SportsFootballContentLeagueGames" }, "ResponseB91D37C29Ffe_SportsFixtureFootball": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "teams": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureTeams" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "start_time": { "type": "integer", "title": "Start Time" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballFixtureStatus" }, { "type": "null" } ] }, "video": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureVideo" }, { "type": "null" } ] }, "ps_score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "events": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballFixtureEvent" }, "type": "array" }, { "type": "null" } ], "title": "Events" }, "competition_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Competition Id" }, "aggregate_score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureAggregateScore" }, { "type": "null" } ] }, "group": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLabel" }, { "type": "null" } ] }, "round": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Round" } }, "type": "object", "required": [ "id", "teams", "start_time" ], "title": "SportsFixtureFootball" }, "ResponseB91D37C29Ffe_SportsLabel": { "properties": { "i18n": { "type": "string", "title": "I18N" }, "i18n_opts": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "I18N Opts" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLabelKind" }, { "type": "null" } ] } }, "type": "object", "required": [ "i18n" ], "title": "SportsLabel" }, "ResponseB91D37C29Ffe_SportsLabelKind": { "type": "string", "enum": [ "qualification", "relegation", "unknown" ], "title": "SportsLabelKind" }, "ResponseB91D37C29Ffe_SportsFootballStandingsGroup": { "properties": { "group_name": { "type": "string", "title": "Group Name" }, "standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballStanding" }, "type": "array", "title": "Standings" } }, "type": "object", "required": [ "group_name", "standings" ], "title": "SportsFootballStandingsGroup" }, "ResponseB91D37C29Ffe_SportsFootballStanding": { "properties": { "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "rank": { "type": "integer", "title": "Rank" }, "matches_played": { "type": "integer", "title": "Matches Played" }, "matches_won": { "type": "integer", "title": "Matches Won" }, "matches_drawn": { "type": "integer", "title": "Matches Drawn" }, "matches_lost": { "type": "integer", "title": "Matches Lost" }, "goals_for": { "type": "integer", "title": "Goals For" }, "goals_against": { "type": "integer", "title": "Goals Against" }, "points": { "type": "integer", "title": "Points" }, "form": { "type": "string", "title": "Form" }, "label": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLabel" }, { "type": "null" } ] } }, "type": "object", "required": [ "team", "rank", "matches_played", "matches_won", "matches_drawn", "matches_lost", "goals_for", "goals_against", "points", "form" ], "title": "SportsFootballStanding" }, "ResponseB91D37C29Ffe_SportsFootballContentTeamStandings": { "properties": { "type": { "type": "string", "enum": [ "team_standings" ], "const": "team_standings", "title": "Type", "default": "team_standings" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "group_standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballStandingsGroup" }, "type": "array", "title": "Group Standings" } }, "type": "object", "required": [ "league", "team", "group_standings" ], "title": "SportsFootballContentTeamStandings" }, "ResponseB91D37C29Ffe_SportsFootballContentLeagueStandings": { "properties": { "type": { "type": "string", "enum": [ "league_standings" ], "const": "league_standings", "title": "Type", "default": "league_standings" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "group_standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballStandingsGroup" }, "type": "array", "title": "Group Standings" } }, "type": "object", "required": [ "league", "group_standings" ], "title": "SportsFootballContentLeagueStandings" }, "ResponseB91D37C29Ffe_SportsFootballContentTeamGames": { "properties": { "type": { "type": "string", "enum": [ "team_games" ], "const": "team_games", "title": "Type", "default": "team_games" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "games": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureFootball" }, "type": "array", "title": "Games" }, "competitions": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCompetition" }, "type": "array", "title": "Competitions" }, "group_standings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFootballStandingsGroup" }, "type": "array" }, { "type": "null" } ], "title": "Group Standings" } }, "type": "object", "required": [ "league", "team", "games", "competitions" ], "title": "SportsFootballContentTeamGames" }, "ResponseB91D37C29Ffe_SportsResultBaseball": { "properties": { "sport": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsType", "default": "baseball" }, "type": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsDataType" }, "view": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsView" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBaseballContentLeagueGames" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBaseballContentLeagueStandings" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBaseballContentTeamGames" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBaseballContentTeamStandings" } ], "title": "Content" } }, "type": "object", "required": [ "type", "view", "content" ], "title": "SportsResultBaseball" }, "ResponseB91D37C29Ffe_SportsBaseballContentLeagueGames": { "properties": { "type": { "type": "string", "enum": [ "league_games" ], "const": "league_games", "title": "Type", "default": "league_games" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "game_times": { "items": { "type": "integer" }, "type": "array", "title": "Game Times" }, "game_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Time" }, "date": { "type": "string", "title": "Date" }, "date_kind": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsDateKind" }, "games": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureBaseball" }, "type": "array", "title": "Games" } }, "type": "object", "required": [ "league", "game_times", "date", "date_kind", "games" ], "title": "SportsBaseballContentLeagueGames" }, "ResponseB91D37C29Ffe_SportsFixtureBaseball": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "teams": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureTeams" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "start_time": { "type": "integer", "title": "Start Time" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBaseballFixtureStatus" }, { "type": "null" } ] }, "video": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureVideo" }, { "type": "null" } ] }, "score_table": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBaseballScoreTable" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "teams", "start_time" ], "title": "SportsFixtureBaseball" }, "ResponseB91D37C29Ffe_SportsBaseballFixtureStatus": { "properties": { "code": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBaseballFixtureStatusCode" }, { "type": "null" } ] } }, "type": "object", "title": "SportsBaseballFixtureStatus" }, "ResponseB91D37C29Ffe_SportsBaseballFixtureStatusCode": { "type": "string", "enum": [ "FT", "NS", "POST", "CANC", "INTR", "ABD", "IN1", "IN2", "IN3", "IN4", "IN5", "IN6", "IN7", "IN8", "IN9" ], "title": "SportsBaseballFixtureStatusCode" }, "ResponseB91D37C29Ffe_SportsBaseballScoreTable": { "properties": { "innings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBaseballInningScore" }, "type": "array", "title": "Innings" }, "extra": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBaseballInningScore" }, { "type": "null" } ] }, "hits": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "errors": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] } }, "type": "object", "required": [ "innings" ], "title": "SportsBaseballScoreTable" }, "ResponseB91D37C29Ffe_SportsBaseballInningScore": { "properties": { "home": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Home" }, "away": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Away" } }, "type": "object", "title": "SportsBaseballInningScore" }, "ResponseB91D37C29Ffe_SportsBaseballContentLeagueStandings": { "properties": { "type": { "type": "string", "enum": [ "league_standings" ], "const": "league_standings", "title": "Type", "default": "league_standings" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "group_standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBaseballStandingsGroup" }, "type": "array", "title": "Group Standings" } }, "type": "object", "required": [ "league", "group_standings" ], "title": "SportsBaseballContentLeagueStandings" }, "ResponseB91D37C29Ffe_SportsBaseballStandingsGroup": { "properties": { "group_name": { "type": "string", "title": "Group Name" }, "standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBaseballStanding" }, "type": "array", "title": "Standings" }, "stage": { "type": "string", "title": "Stage" } }, "type": "object", "required": [ "group_name", "standings", "stage" ], "title": "SportsBaseballStandingsGroup" }, "ResponseB91D37C29Ffe_SportsBaseballStanding": { "properties": { "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "rank": { "type": "integer", "title": "Rank" }, "matches_played": { "type": "integer", "title": "Matches Played" }, "matches_won": { "type": "integer", "title": "Matches Won" }, "matches_won_pros": { "type": "string", "title": "Matches Won Pros" }, "matches_lost": { "type": "integer", "title": "Matches Lost" }, "matches_lost_pros": { "type": "string", "title": "Matches Lost Pros" }, "games_behind": { "type": "number", "title": "Games Behind" }, "form": { "type": "string", "title": "Form" } }, "type": "object", "required": [ "team", "rank", "matches_played", "matches_won", "matches_won_pros", "matches_lost", "matches_lost_pros", "games_behind", "form" ], "title": "SportsBaseballStanding" }, "ResponseB91D37C29Ffe_SportsBaseballContentTeamGames": { "properties": { "type": { "type": "string", "enum": [ "team_games" ], "const": "team_games", "title": "Type", "default": "team_games" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "games": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureBaseball" }, "type": "array", "title": "Games" } }, "type": "object", "required": [ "league", "team", "games" ], "title": "SportsBaseballContentTeamGames" }, "ResponseB91D37C29Ffe_SportsBaseballContentTeamStandings": { "properties": { "type": { "type": "string", "enum": [ "team_standings" ], "const": "team_standings", "title": "Type", "default": "team_standings" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "group_standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBaseballStandingsGroup" }, "type": "array", "title": "Group Standings" } }, "type": "object", "required": [ "league", "team", "group_standings" ], "title": "SportsBaseballContentTeamStandings" }, "ResponseB91D37C29Ffe_SportsResultBasketball": { "properties": { "sport": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsType", "default": "basketball" }, "type": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsDataType" }, "view": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsView" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBasketballContentLeagueGames" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBasketballContentLeagueStandings" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBasketballContentTeamGames" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBasketballContentTeamStandings" } ], "title": "Content" } }, "type": "object", "required": [ "type", "view", "content" ], "title": "SportsResultBasketball" }, "ResponseB91D37C29Ffe_SportsBasketballContentLeagueGames": { "properties": { "type": { "type": "string", "enum": [ "league_games" ], "const": "league_games", "title": "Type", "default": "league_games" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "game_times": { "items": { "type": "integer" }, "type": "array", "title": "Game Times" }, "game_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Time" }, "date": { "type": "string", "title": "Date" }, "date_kind": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsDateKind" }, "games": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureBasketball" }, "type": "array", "title": "Games" } }, "type": "object", "required": [ "league", "game_times", "date", "date_kind", "games" ], "title": "SportsBasketballContentLeagueGames" }, "ResponseB91D37C29Ffe_SportsFixtureBasketball": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "teams": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureTeams" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "start_time": { "type": "integer", "title": "Start Time" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBasketballFixtureStatus" }, { "type": "null" } ] }, "video": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureVideo" }, { "type": "null" } ] }, "score_table": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBasketballScoreTable" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "teams", "start_time" ], "title": "SportsFixtureBasketball" }, "ResponseB91D37C29Ffe_SportsBasketballFixtureStatus": { "properties": { "code": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBasketballFixtureStatusCode" }, { "type": "null" } ] } }, "type": "object", "title": "SportsBasketballFixtureStatus" }, "ResponseB91D37C29Ffe_SportsBasketballFixtureStatusCode": { "type": "string", "enum": [ "FT", "AOT", "NS", "POST", "CANC", "SUSP", "Q1", "Q2", "Q3", "Q4", "BT", "OT", "HT" ], "title": "SportsBasketballFixtureStatusCode" }, "ResponseB91D37C29Ffe_SportsBasketballScoreTable": { "properties": { "q1": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "q2": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "q3": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "q4": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "ot": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] } }, "type": "object", "title": "SportsBasketballScoreTable" }, "ResponseB91D37C29Ffe_SportsBasketballContentLeagueStandings": { "properties": { "type": { "type": "string", "enum": [ "league_standings" ], "const": "league_standings", "title": "Type", "default": "league_standings" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "group_standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBasketballStandingsGroup" }, "type": "array", "title": "Group Standings" } }, "type": "object", "required": [ "league", "group_standings" ], "title": "SportsBasketballContentLeagueStandings" }, "ResponseB91D37C29Ffe_SportsBasketballStandingsGroup": { "properties": { "group_name": { "type": "string", "title": "Group Name" }, "standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBasketballStanding" }, "type": "array", "title": "Standings" }, "stage": { "type": "string", "title": "Stage" } }, "type": "object", "required": [ "group_name", "standings", "stage" ], "title": "SportsBasketballStandingsGroup" }, "ResponseB91D37C29Ffe_SportsBasketballStanding": { "properties": { "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "rank": { "type": "integer", "title": "Rank" }, "matches_played": { "type": "integer", "title": "Matches Played" }, "matches_won": { "type": "integer", "title": "Matches Won" }, "matches_won_pros": { "type": "string", "title": "Matches Won Pros" }, "matches_lost": { "type": "integer", "title": "Matches Lost" }, "matches_lost_pros": { "type": "string", "title": "Matches Lost Pros" }, "games_behind": { "type": "number", "title": "Games Behind" } }, "type": "object", "required": [ "team", "rank", "matches_played", "matches_won", "matches_won_pros", "matches_lost", "matches_lost_pros", "games_behind" ], "title": "SportsBasketballStanding" }, "ResponseB91D37C29Ffe_SportsBasketballContentTeamGames": { "properties": { "type": { "type": "string", "enum": [ "team_games" ], "const": "team_games", "title": "Type", "default": "team_games" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "games": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureBasketball" }, "type": "array", "title": "Games" } }, "type": "object", "required": [ "league", "team", "games" ], "title": "SportsBasketballContentTeamGames" }, "ResponseB91D37C29Ffe_SportsBasketballContentTeamStandings": { "properties": { "type": { "type": "string", "enum": [ "team_standings" ], "const": "team_standings", "title": "Type", "default": "team_standings" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "group_standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsBasketballStandingsGroup" }, "type": "array", "title": "Group Standings" } }, "type": "object", "required": [ "league", "team", "group_standings" ], "title": "SportsBasketballContentTeamStandings" }, "ResponseB91D37C29Ffe_SportsResultIceHockey": { "properties": { "sport": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsType", "default": "ice_hockey" }, "type": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsDataType" }, "view": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsView" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsIceHockeyContentLeagueGames" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsIceHockeyContentLeagueStandings" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsIceHockeyContentTeamGames" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsIceHockeyContentTeamStandings" } ], "title": "Content" } }, "type": "object", "required": [ "type", "view", "content" ], "title": "SportsResultIceHockey" }, "ResponseB91D37C29Ffe_SportsIceHockeyContentLeagueGames": { "properties": { "type": { "type": "string", "enum": [ "league_games" ], "const": "league_games", "title": "Type", "default": "league_games" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "game_times": { "items": { "type": "integer" }, "type": "array", "title": "Game Times" }, "game_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Time" }, "date": { "type": "string", "title": "Date" }, "date_kind": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsDateKind" }, "games": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureIceHockey" }, "type": "array", "title": "Games" } }, "type": "object", "required": [ "league", "game_times", "date", "date_kind", "games" ], "title": "SportsIceHockeyContentLeagueGames" }, "ResponseB91D37C29Ffe_SportsFixtureIceHockey": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "teams": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureTeams" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "start_time": { "type": "integer", "title": "Start Time" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsIceHockeyFixtureStatus" }, { "type": "null" } ] }, "video": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureVideo" }, { "type": "null" } ] }, "score_table": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsIceHockeyScoreTable" }, { "type": "null" } ] }, "league_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "League Id" } }, "type": "object", "required": [ "id", "teams", "start_time" ], "title": "SportsFixtureIceHockey" }, "ResponseB91D37C29Ffe_SportsIceHockeyFixtureStatus": { "properties": { "code": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsIceHockeyFixtureStatusCode" }, { "type": "null" } ] }, "elapsed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Elapsed" } }, "type": "object", "title": "SportsIceHockeyFixtureStatus" }, "ResponseB91D37C29Ffe_SportsIceHockeyFixtureStatusCode": { "type": "string", "enum": [ "NS", "P1", "P2", "P3", "OT", "PT", "BT", "AW", "POST", "CANC", "INTR", "ABD", "AOT", "AP", "FT" ], "title": "SportsIceHockeyFixtureStatusCode" }, "ResponseB91D37C29Ffe_SportsIceHockeyScoreTable": { "properties": { "p1": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "p2": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "p3": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "ot": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] }, "so": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureScore" }, { "type": "null" } ] } }, "type": "object", "title": "SportsIceHockeyScoreTable" }, "ResponseB91D37C29Ffe_SportsIceHockeyContentLeagueStandings": { "properties": { "type": { "type": "string", "enum": [ "league_standings" ], "const": "league_standings", "title": "Type", "default": "league_standings" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "group_standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsIceHockeyStandingsGroup" }, "type": "array", "title": "Group Standings" } }, "type": "object", "required": [ "league", "group_standings" ], "title": "SportsIceHockeyContentLeagueStandings" }, "ResponseB91D37C29Ffe_SportsIceHockeyStandingsGroup": { "properties": { "group_name": { "type": "string", "title": "Group Name" }, "standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsIceHockeyStanding" }, "type": "array", "title": "Standings" }, "stage": { "type": "string", "title": "Stage" } }, "type": "object", "required": [ "group_name", "standings", "stage" ], "title": "SportsIceHockeyStandingsGroup" }, "ResponseB91D37C29Ffe_SportsIceHockeyStanding": { "properties": { "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "rank": { "type": "integer", "title": "Rank" }, "matches_played": { "type": "integer", "title": "Matches Played" }, "matches_won": { "type": "integer", "title": "Matches Won" }, "matches_won_pros": { "type": "string", "title": "Matches Won Pros" }, "matches_lost": { "type": "integer", "title": "Matches Lost" }, "matches_lost_pros": { "type": "string", "title": "Matches Lost Pros" }, "points": { "type": "integer", "title": "Points" }, "form": { "type": "string", "title": "Form" } }, "type": "object", "required": [ "team", "rank", "matches_played", "matches_won", "matches_won_pros", "matches_lost", "matches_lost_pros", "points", "form" ], "title": "SportsIceHockeyStanding" }, "ResponseB91D37C29Ffe_SportsIceHockeyContentTeamGames": { "properties": { "type": { "type": "string", "enum": [ "team_games" ], "const": "team_games", "title": "Type", "default": "team_games" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "games": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureIceHockey" }, "type": "array", "title": "Games" } }, "type": "object", "required": [ "league", "team", "games" ], "title": "SportsIceHockeyContentTeamGames" }, "ResponseB91D37C29Ffe_SportsIceHockeyContentTeamStandings": { "properties": { "type": { "type": "string", "enum": [ "team_standings" ], "const": "team_standings", "title": "Type", "default": "team_standings" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "group_standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsIceHockeyStandingsGroup" }, "type": "array", "title": "Group Standings" } }, "type": "object", "required": [ "league", "team", "group_standings" ], "title": "SportsIceHockeyContentTeamStandings" }, "ResponseB91D37C29Ffe_SportsResultCricket": { "properties": { "sport": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsType", "default": "cricket" }, "type": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsDataType" }, "view": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsView" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentLeagueGames" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentLeagueStandings" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentTeamGames" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentTeamStandings" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixture" } ], "title": "Content" } }, "type": "object", "required": [ "type", "view", "content" ], "title": "SportsResultCricket" }, "ResponseB91D37C29Ffe_SportsCricketContentLeagueGames": { "properties": { "type": { "type": "string", "enum": [ "league_games" ], "const": "league_games", "title": "Type", "default": "league_games" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "game_times": { "items": { "type": "integer" }, "type": "array", "title": "Game Times" }, "game_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Time" }, "date": { "type": "string", "title": "Date" }, "date_kind": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsDateKind" }, "games": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureCricket" }, "type": "array", "title": "Games" } }, "type": "object", "required": [ "league", "game_times", "date", "date_kind", "games" ], "title": "SportsCricketContentLeagueGames" }, "ResponseB91D37C29Ffe_SportsFixtureCricket": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "teams": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureTeams" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketFixtureScore" }, { "type": "null" } ] }, "start_time": { "type": "integer", "title": "Start Time" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketFixtureStatus" }, { "type": "null" } ] }, "video": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureVideo" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "teams", "start_time" ], "title": "SportsFixtureCricket" }, "ResponseB91D37C29Ffe_SportsCricketFixtureScore": { "properties": { "home": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Home" }, "away": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Away" }, "home_runs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Home Runs" }, "home_overs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Home Overs" }, "away_runs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Away Runs" }, "away_overs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Away Overs" } }, "type": "object", "required": [ "home", "away" ], "title": "SportsCricketFixtureScore" }, "ResponseB91D37C29Ffe_SportsCricketFixtureStatus": { "properties": { "code": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketFixtureStatusCode" }, { "type": "null" } ] } }, "type": "object", "title": "SportsCricketFixtureStatus" }, "ResponseB91D37C29Ffe_SportsCricketFixtureStatusCode": { "type": "string", "enum": [ "ABN", "BRK", "FT", "LIVE", "NS", "PST", "SDL", "SPR", "STM", "TRB" ], "title": "SportsCricketFixtureStatusCode" }, "ResponseB91D37C29Ffe_SportsCricketContentLeagueStandings": { "properties": { "type": { "type": "string", "enum": [ "league_standings" ], "const": "league_standings", "title": "Type", "default": "league_standings" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "group_standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketStandingsGroup" }, "type": "array", "title": "Group Standings" } }, "type": "object", "required": [ "league", "group_standings" ], "title": "SportsCricketContentLeagueStandings" }, "ResponseB91D37C29Ffe_SportsCricketStandingsGroup": { "properties": { "group_name": { "type": "string", "title": "Group Name" }, "standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketStanding" }, "type": "array", "title": "Standings" } }, "type": "object", "required": [ "group_name", "standings" ], "title": "SportsCricketStandingsGroup" }, "ResponseB91D37C29Ffe_SportsCricketStanding": { "properties": { "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "rank": { "type": "integer", "title": "Rank" }, "matches_played": { "type": "integer", "title": "Matches Played" }, "matches_won": { "type": "integer", "title": "Matches Won" }, "matches_drawn": { "type": "string", "title": "Matches Drawn" }, "matches_lost": { "type": "integer", "title": "Matches Lost" }, "matches_no_result": { "type": "string", "title": "Matches No Result" }, "points": { "type": "string", "title": "Points" }, "net_run_rate": { "type": "number", "title": "Net Run Rate" } }, "type": "object", "required": [ "team", "rank", "matches_played", "matches_won", "matches_drawn", "matches_lost", "matches_no_result", "points", "net_run_rate" ], "title": "SportsCricketStanding" }, "ResponseB91D37C29Ffe_SportsCricketContentTeamGames": { "properties": { "type": { "type": "string", "enum": [ "team_games" ], "const": "team_games", "title": "Type", "default": "team_games" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "games": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureCricket" }, "type": "array", "title": "Games" } }, "type": "object", "required": [ "league", "team", "games" ], "title": "SportsCricketContentTeamGames" }, "ResponseB91D37C29Ffe_SportsCricketContentTeamStandings": { "properties": { "type": { "type": "string", "enum": [ "team_standings" ], "const": "team_standings", "title": "Type", "default": "team_standings" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "team": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsTeam" }, "group_standings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketStandingsGroup" }, "type": "array", "title": "Group Standings" } }, "type": "object", "required": [ "league", "team", "group_standings" ], "title": "SportsCricketContentTeamStandings" }, "ResponseB91D37C29Ffe_SportsCricketContentFixture": { "properties": { "type": { "type": "string", "enum": [ "fixture" ], "const": "fixture", "title": "Type", "default": "fixture" }, "league": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsLeague" }, "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "start_time": { "type": "integer", "title": "Start Time" }, "teams": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsFixtureTeams" }, "status": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketFixtureStatus" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketFixtureScore" }, { "type": "null" } ] }, "upcoming": { "type": "boolean", "title": "Upcoming" }, "venue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Venue Name" }, "details": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetails" }, "lineups": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureLineup" }, "type": "array", "title": "Lineups" } }, "type": "object", "required": [ "league", "id", "start_time", "teams", "status", "upcoming", "details", "lineups" ], "title": "SportsCricketContentFixture" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureDetails": { "properties": { "innings": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInning" }, "type": "array", "title": "Innings", "default": [] }, "matchDay": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Matchday" }, "numberDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Numberdays" }, "night": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Night" }, "dl": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Dl" }, "statusId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Statusid" }, "winTypeId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wintypeid" }, "winnerId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Winnerid" }, "result": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result" }, "minOversRemaining": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Minoversremaining" }, "totalOvers": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Totalovers" }, "winMargin": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Winmargin" }, "tossWinnerTeamId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tosswinnerteamid" }, "toss": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Toss" }, "tossDecision": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tossdecision" }, "awayBattingBonus": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Awaybattingbonus" }, "awayBowlingBonus": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Awaybowlingbonus" }, "homeBattingBonus": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Homebattingbonus" }, "homeBowlingBonus": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Homebowlingbonus" }, "playerOfTheMatch1Id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playerofthematch1Id" }, "playerOfTheMatch2Id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playerofthematch2Id" }, "playerOfTheMatch1Name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playerofthematch1Name" }, "playerOfTheMatch2Name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playerofthematch2Name" }, "playerOfTheSeries1Id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playeroftheseries1Id" }, "playerOfTheSeries2Id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playeroftheseries2Id" }, "playerOfTheSeries1Name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playeroftheseries1Name" }, "playerOfTheSeries2Name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playeroftheseries2Name" } }, "type": "object", "title": "SportsCricketContentFixtureDetails" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInning": { "properties": { "batters": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningBatters" }, { "type": "null" } ] }, "bowlers": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningBowlers" }, { "type": "null" } ] }, "extras": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningExtras" }, { "type": "null" } ] }, "fallOfWickets": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningFallOfWickets" }, { "type": "null" } ] }, "total": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningTotal" }, { "type": "null" } ] }, "id": { "type": "integer", "title": "Id" }, "battingTeamId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Battingteamid" }, "bowlingTeamId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bowlingteamid" }, "declared": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Declared" }, "dlOvers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dlovers" }, "dlTarget": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Dltarget" }, "followOn": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Followon" }, "forfeited": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Forfeited" }, "overnightRuns": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Overnightruns" }, "overnightWickets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Overnightwickets" }, "team": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningTeam" }, { "type": "null" } ] }, "bestBatters": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningBatter" }, "type": "array", "title": "Bestbatters", "default": [] }, "bestBowlers": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningBowler" }, "type": "array", "title": "Bestbowlers", "default": [] } }, "type": "object", "required": [ "id" ], "title": "SportsCricketContentFixtureDetailsInning" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningBatters": { "properties": { "batter": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningBatter" }, "type": "array", "title": "Batter", "default": [] } }, "type": "object", "title": "SportsCricketContentFixtureDetailsInningBatters" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningBatter": { "properties": { "id": { "type": "string", "title": "Id" }, "ballsFaced": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ballsfaced" }, "bowledById": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bowledbyid" }, "caughtById": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Caughtbyid" }, "day": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Day" }, "dismissalId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Dismissalid" }, "foursScored": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Foursscored" }, "howOut": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Howout" }, "minutes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Minutes" }, "nonStrike": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Nonstrike" }, "onStrike": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Onstrike" }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" }, "runsScored": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Runsscored" }, "sixesScored": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sixesscored" } }, "type": "object", "required": [ "id" ], "title": "SportsCricketContentFixtureDetailsInningBatter" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningBowlers": { "properties": { "bowler": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningBowler" }, "type": "array", "title": "Bowler", "default": [] } }, "type": "object", "title": "SportsCricketContentFixtureDetailsInningBowlers" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningBowler": { "properties": { "id": { "type": "string", "title": "Id" }, "ballsBowled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ballsbowled" }, "totalBallsBowled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Totalballsbowled" }, "dotBalls": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Dotballs" }, "maidensBowled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maidensbowled" }, "noBalls": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Noballs" }, "nonStrike": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Nonstrike" }, "onStrike": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Onstrike" }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" }, "oversBowled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Oversbowled" }, "runsConceded": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Runsconceded" }, "wicketsTaken": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wicketstaken" }, "wides": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wides" } }, "type": "object", "required": [ "id" ], "title": "SportsCricketContentFixtureDetailsInningBowler" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningExtras": { "properties": { "byes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Byes" }, "legByes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Legbyes" }, "noBalls": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Noballs" }, "penalties": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Penalties" }, "totalExtras": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Totalextras" }, "wides": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wides" } }, "type": "object", "title": "SportsCricketContentFixtureDetailsInningExtras" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningFallOfWickets": { "properties": { "fallOfWicket": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningFallOfWicket" }, "type": "array", "title": "Fallofwicket", "default": [] } }, "type": "object", "title": "SportsCricketContentFixtureDetailsInningFallOfWickets" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningFallOfWicket": { "properties": { "playerId": { "type": "string", "title": "Playerid" }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" }, "overBall": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Overball" }, "runs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Runs" }, "totalBallsBowled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Totalballsbowled" } }, "type": "object", "required": [ "playerId" ], "title": "SportsCricketContentFixtureDetailsInningFallOfWicket" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningTotal": { "properties": { "runsScored": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Runsscored" }, "wickets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wickets" }, "overs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Overs" } }, "type": "object", "title": "SportsCricketContentFixtureDetailsInningTotal" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureDetailsInningTeam": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location" }, "name": { "type": "string", "title": "Name" }, "logo": { "type": "string", "title": "Logo" }, "score": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Score" }, "runs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runs" }, "overs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Overs" } }, "type": "object", "required": [ "name", "logo" ], "title": "SportsCricketContentFixtureDetailsInningTeam" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureLineup": { "properties": { "player": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SportsCricketContentFixtureLineupPlayer" }, "type": "array", "title": "Player", "default": [] }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "SportsCricketContentFixtureLineup" }, "ResponseB91D37C29Ffe_SportsCricketContentFixtureLineupPlayer": { "properties": { "id": { "type": "string", "title": "Id" }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middlename" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "matchName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Matchname" }, "initials": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Initials" }, "teamRole": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Teamrole" }, "gameRole": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gamerole" } }, "type": "object", "required": [ "id" ], "title": "SportsCricketContentFixtureLineupPlayer" }, "ResponseB91D37C29Ffe_StockResult": { "properties": { "asset_info": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_AssetInfo" }, "time_range": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_TickerPlotTimeRange" }, "quote": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_snakepit__models__rich_header__results__stocks__v1__Quote" }, "timeseries": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_StockResultTimeseries" }, "exchange_info": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ExchangeInfo" }, { "type": "null" } ] } }, "type": "object", "required": [ "asset_info", "time_range", "quote", "timeseries" ], "title": "StockResult" }, "ResponseB91D37C29Ffe_AssetInfo": { "properties": { "symbol": { "type": "string", "title": "Symbol" }, "name": { "type": "string", "title": "Name" }, "category": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_FinancialInstrumentCategory" }, "currency": { "type": "string", "title": "Currency" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" }, "exchange": { "type": "string", "title": "Exchange" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "mic_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mic Code" }, "score": { "type": "number", "title": "Score", "default": -1 } }, "type": "object", "required": [ "symbol", "name", "category", "currency", "exchange" ], "title": "AssetInfo" }, "ResponseB91D37C29Ffe_FinancialInstrumentCategory": { "type": "string", "enum": [ "stock", "index", "fund", "etf", "bond", "other" ], "title": "FinancialInstrumentCategory" }, "ResponseB91D37C29Ffe_snakepit__models__rich_header__results__stocks__v1__Quote": { "properties": { "symbol": { "type": "string", "title": "Symbol" }, "company_name": { "type": "string", "title": "Company Name" }, "primary_exchange": { "type": "string", "title": "Primary Exchange" }, "market_cap": { "type": "integer", "title": "Market Cap" }, "pe_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pe Ratio" }, "week_52_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Week 52 High" }, "week_52_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Week 52 Low" }, "latest_price": { "type": "number", "title": "Latest Price" }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open" }, "close": { "type": "number", "title": "Close" }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High" }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low" }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change" }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percent" }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume" }, "latest_update": { "type": "integer", "title": "Latest Update" }, "currency": { "type": "string", "title": "Currency" } }, "type": "object", "required": [ "symbol", "company_name", "primary_exchange", "market_cap", "latest_price", "close", "latest_update", "currency" ], "title": "Quote" }, "ResponseB91D37C29Ffe_StockResultTimeseries": { "properties": { "time_range": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_TickerPlotTimeRange" }, "timeseries": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_StockObservation" }, "type": "array", "title": "Timeseries" } }, "type": "object", "required": [ "time_range", "timeseries" ], "title": "StockResultTimeseries" }, "ResponseB91D37C29Ffe_StockObservation": { "properties": { "date": { "type": "string", "title": "Date" }, "minute": { "type": "string", "title": "Minute" }, "label": { "type": "string", "title": "Label" }, "timestamp": { "type": "integer", "title": "Timestamp" }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High" }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low" }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close" }, "previous_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Previous Close" }, "average": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average" }, "volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Volume" } }, "type": "object", "required": [ "date", "minute", "label", "timestamp" ], "title": "StockObservation" }, "ResponseB91D37C29Ffe_ExchangeInfo": { "properties": { "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" }, "open_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Open Time" }, "close_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Close Time" } }, "type": "object", "title": "ExchangeInfo" }, "ResponseB91D37C29Ffe_UnitConversionResult": { "properties": { "amount": { "type": "number", "title": "Amount" }, "from_unit": { "type": "string", "title": "From Unit" }, "to_unit": { "type": "string", "title": "To Unit" }, "dimensionality": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_UnitConversionDimensionality" } }, "type": "object", "required": [ "amount", "from_unit", "to_unit", "dimensionality" ], "title": "UnitConversionResult" }, "ResponseB91D37C29Ffe_UnitConversionDimensionality": { "type": "string", "enum": [ "angle", "area", "data_transfer", "digital", "duration", "energy", "force", "frequency", "length", "mass", "power", "pressure", "speed", "temperature", "volume" ], "title": "UnitConversionDimensionality" }, "ResponseB91D37C29Ffe_UnixTimestampResult": { "properties": { "conversion": { "oneOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_TsToDate" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_DateToTs" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_NowToTs" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_NowToDate" } ], "title": "Conversion", "discriminator": { "propertyName": "intent_type", "mapping": { "date_to_ts": "#/components/schemas/ResponseB91D37C29Ffe_DateToTs", "now_to_date": "#/components/schemas/ResponseB91D37C29Ffe_NowToDate", "now_to_ts": "#/components/schemas/ResponseB91D37C29Ffe_NowToTs", "ts_to_date": "#/components/schemas/ResponseB91D37C29Ffe_TsToDate" } } } }, "type": "object", "required": [ "conversion" ], "title": "UnixTimestampResult" }, "ResponseB91D37C29Ffe_DateToTs": { "properties": { "intent_type": { "type": "string", "enum": [ "date_to_ts" ], "const": "date_to_ts", "title": "Intent Type", "default": "date_to_ts" }, "input_date": { "type": "string", "title": "Input Date" } }, "type": "object", "required": [ "input_date" ], "title": "DateToTs" }, "ResponseB91D37C29Ffe_NowToDate": { "properties": { "intent_type": { "type": "string", "enum": [ "now_to_date" ], "const": "now_to_date", "title": "Intent Type", "default": "now_to_date" } }, "type": "object", "title": "NowToDate" }, "ResponseB91D37C29Ffe_NowToTs": { "properties": { "intent_type": { "type": "string", "enum": [ "now_to_ts" ], "const": "now_to_ts", "title": "Intent Type", "default": "now_to_ts" } }, "type": "object", "title": "NowToTs" }, "ResponseB91D37C29Ffe_TsToDate": { "properties": { "intent_type": { "type": "string", "enum": [ "ts_to_date" ], "const": "ts_to_date", "title": "Intent Type", "default": "ts_to_date" }, "input_ts": { "type": "integer", "title": "Input Ts" } }, "type": "object", "required": [ "input_ts" ], "title": "TsToDate" }, "ResponseB91D37C29Ffe_WeatherResult": { "properties": { "location": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_snakepit__models__rich_header__results__weather__v1__Location" }, "current_time_iso": { "type": "string", "title": "Current Time Iso" }, "current_weather": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_CurrentWeather" }, "daily": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_WeatherSummaryDay" }, "type": "array", "title": "Daily" }, "hours3": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_WeatherSummary3Hours" }, "type": "array", "title": "Hours3" }, "alerts": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_WeatherAlert" }, "type": "array", "title": "Alerts", "default": [] } }, "type": "object", "required": [ "location", "current_time_iso", "current_weather", "daily", "hours3" ], "title": "WeatherResult" }, "ResponseB91D37C29Ffe_snakepit__models__rich_header__results__weather__v1__Location": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "country": { "type": "string", "title": "Country" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "coords": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Coordinates" }, "population": { "type": "integer", "title": "Population" }, "sunrise": { "type": "integer", "title": "Sunrise" }, "sunset": { "type": "integer", "title": "Sunset" }, "tzoffset": { "type": "integer", "title": "Tzoffset" }, "implicit_location": { "type": "boolean", "title": "Implicit Location", "default": false } }, "type": "object", "required": [ "id", "name", "country", "coords", "population", "sunrise", "sunset", "tzoffset" ], "title": "Location" }, "ResponseB91D37C29Ffe_Coordinates": { "properties": { "lat": { "type": "number", "title": "Lat" }, "lon": { "type": "number", "title": "Lon" } }, "type": "object", "required": [ "lat", "lon" ], "title": "Coordinates" }, "ResponseB91D37C29Ffe_CurrentWeather": { "properties": { "ts": { "type": "integer", "title": "Ts" }, "sunrise": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sunrise" }, "sunset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sunset" }, "temp": { "type": "number", "title": "Temp" }, "feels_like": { "type": "number", "title": "Feels Like" }, "pressure": { "type": "integer", "title": "Pressure" }, "humidity": { "type": "integer", "title": "Humidity" }, "dew_point": { "type": "number", "title": "Dew Point" }, "uvi": { "type": "number", "title": "Uvi" }, "clouds": { "type": "integer", "title": "Clouds" }, "visibility": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Visibility" }, "wind": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_WindSnapshot" }, "weather": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_WeatherSnapshot" }, "rain": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rain" }, "snow": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Snow" } }, "type": "object", "required": [ "ts", "temp", "feels_like", "pressure", "humidity", "dew_point", "uvi", "clouds", "visibility", "wind", "weather" ], "title": "CurrentWeather" }, "ResponseB91D37C29Ffe_WindSnapshot": { "properties": { "speed": { "type": "number", "title": "Speed" }, "deg": { "type": "integer", "title": "Deg" }, "gust": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gust" } }, "type": "object", "required": [ "speed", "deg" ], "title": "WindSnapshot" }, "ResponseB91D37C29Ffe_WeatherSnapshot": { "properties": { "id": { "type": "integer", "title": "Id" }, "main": { "type": "string", "title": "Main" }, "description": { "type": "string", "title": "Description" }, "icon": { "type": "string", "title": "Icon" } }, "type": "object", "required": [ "id", "main", "description", "icon" ], "title": "WeatherSnapshot" }, "ResponseB91D37C29Ffe_WeatherSummaryDay": { "properties": { "ts": { "type": "integer", "title": "Ts" }, "date_i18n": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date I18N" }, "sunrise": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sunrise" }, "sunset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sunset" }, "moonrise": { "type": "integer", "title": "Moonrise" }, "moonset": { "type": "integer", "title": "Moonset" }, "temperature": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_TemperatureDailySummary" }, "feels_like": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_TemperatureDailyFeelsLikeSummary" }, "pressure": { "type": "integer", "title": "Pressure" }, "humidity": { "type": "integer", "title": "Humidity" }, "dew_point": { "type": "number", "title": "Dew Point" }, "wind": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_WindSnapshot" }, "clouds": { "type": "integer", "title": "Clouds" }, "pop": { "type": "number", "title": "Pop" }, "rain": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rain" }, "uvi": { "type": "number", "title": "Uvi" }, "weather": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_WeatherSnapshot" } }, "type": "object", "required": [ "ts", "moonrise", "moonset", "temperature", "feels_like", "pressure", "humidity", "dew_point", "wind", "clouds", "pop", "uvi", "weather" ], "title": "WeatherSummaryDay" }, "ResponseB91D37C29Ffe_TemperatureDailySummary": { "properties": { "day": { "type": "number", "title": "Day" }, "min": { "type": "number", "title": "Min" }, "max": { "type": "number", "title": "Max" }, "night": { "type": "number", "title": "Night" }, "evening": { "type": "number", "title": "Evening" }, "morning": { "type": "number", "title": "Morning" } }, "type": "object", "required": [ "day", "min", "max", "night", "evening", "morning" ], "title": "TemperatureDailySummary" }, "ResponseB91D37C29Ffe_TemperatureDailyFeelsLikeSummary": { "properties": { "day": { "type": "number", "title": "Day" }, "night": { "type": "number", "title": "Night" }, "evening": { "type": "number", "title": "Evening" }, "morning": { "type": "number", "title": "Morning" } }, "type": "object", "required": [ "day", "night", "evening", "morning" ], "title": "TemperatureDailyFeelsLikeSummary" }, "ResponseB91D37C29Ffe_WeatherSummary3Hours": { "properties": { "ts": { "type": "integer", "title": "Ts" }, "temperature": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_TemperatureSummary3Hours" }, "pressure": { "type": "integer", "title": "Pressure", "description": "Atmospheric pressure, hPa" }, "weather": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_WeatherSnapshot", "description": "Weather conditions information" }, "wind": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_WindSnapshot", "description": "Wind information" }, "humidity": { "type": "integer", "title": "Humidity", "description": "Humidity, %" }, "clouds": { "type": "integer", "title": "Clouds", "description": "Cloudiness, %" }, "pop": { "type": "number", "title": "Pop", "description": "Probability of precipitation" }, "visibility": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Visibility", "description": "Average visibility, metres. The maximum value of the visibility is 10 km" }, "rain": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rain", "description": "Rain volume in millimeters." }, "snow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Snow", "description": "Snow volume in millimeters." } }, "type": "object", "required": [ "ts", "temperature", "pressure", "weather", "wind", "humidity", "clouds", "pop" ], "title": "WeatherSummary3Hours" }, "ResponseB91D37C29Ffe_TemperatureSummary3Hours": { "properties": { "temp": { "type": "number", "title": "Temp" }, "feels_like": { "type": "number", "title": "Feels Like" }, "min": { "type": "number", "title": "Min" }, "max": { "type": "number", "title": "Max" } }, "type": "object", "required": [ "temp", "feels_like", "min", "max" ], "title": "TemperatureSummary3Hours" }, "ResponseB91D37C29Ffe_WeatherAlert": { "properties": { "sender": { "type": "string", "title": "Sender" }, "event": { "type": "string", "title": "Event" }, "ts_start": { "type": "integer", "title": "Ts Start" }, "ts_end": { "type": "integer", "title": "Ts End" }, "start_relative_i18n": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Relative I18N" }, "description": { "type": "string", "title": "Description" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" } }, "type": "object", "required": [ "sender", "event", "ts_start", "ts_end", "description", "tags" ], "title": "WeatherAlert" }, "ResponseB91D37C29Ffe_ResponseCallbackInfo": { "properties": { "vertical": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SearchAPIVertical" }, { "type": "null" } ], "description": "The vertical associated with the callback. For the full list of verticals supported see the Rich Vertical list." }, "callback_key": { "type": "string", "title": "Callback Key", "description": "The unique key for the callback." }, "callback_status": { "type": "string", "enum": [ "success", "failure" ], "title": "Callback Status", "description": "The status of the callback operation. The value is either success or failure." }, "search_lang": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_snakepit__models__mixer__general__Language", "description": "The language used for the search.", "default": "en" } }, "type": "object", "required": [ "callback_key", "callback_status" ], "title": "ResponseCallbackInfo" }, "ResponseB91D37C29Ffe_snakepit__models__mixer__general__Language": { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, "ResponseB91D37C29Ffe_WebSearchApiResponse": { "properties": { "type": { "type": "string", "enum": [ "search" ], "const": "search", "title": "Type", "default": "search" }, "query": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__query__Query" }, { "type": "null" } ], "description": "Search query string and its modifications that are used for search." }, "discussions": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Discussions" }, { "type": "null" } ], "description": "Discussions clusters aggregated from forum posts that are relevant to the query." }, "faq": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__faq__FAQ" }, { "type": "null" } ], "description": "Frequently asked questions that are relevant to the search query." }, "infobox": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_GraphInfobox" }, { "type": "null" } ], "description": "Aggregated information on an entity showable as an infobox." }, "locations": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Locations" }, { "type": "null" } ], "description": "Places of interest (POIs) relevant to location sensitive queries." }, "mixed": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_MixedResponse" }, { "type": "null" } ], "description": "Preferred ranked order of search results." }, "news": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_News" }, { "type": "null" } ], "description": "News results relevant to the query." }, "videos": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Videos" }, { "type": "null" } ], "description": "Videos results relevant to the query." }, "web": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Search" }, { "type": "null" } ], "description": "Web results relevant to the query." }, "summarizer": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Summarizer" }, { "type": "null" } ], "description": "Summary key to get summary results for the query." }, "rich": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_RichHeaderCallback" }, { "type": "null" } ], "description": "Callback information to retrieve rich results." } }, "type": "object", "title": "WebSearchApiResponse" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__query__Query": { "properties": { "original": { "type": "string", "title": "Original", "description": "The original query that was requested." }, "show_strict_warning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Show Strict Warning", "description": "Whether to show a warning that strict safesearch filtered results." }, "altered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Altered", "description": "The altered query by the spellchecker." }, "cleaned": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cleaned", "description": "The cleaned normalized query." }, "safesearch": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Safesearch", "description": "Whether safesearch is active." }, "is_navigational": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Navigational", "description": "Whether the query is navigational (user wants to go to a specific site)." }, "is_geolocal": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Geolocal", "description": "Whether the query has local intent." }, "local_decision": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Local Decision", "description": "The local search decision for the query." }, "local_locations_idx": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Local Locations Idx", "description": "Index of the local location result." }, "is_trending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Trending", "description": "Whether the query is a trending topic." }, "is_news_breaking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is News Breaking", "description": "Whether the query is related to breaking news." }, "ask_for_location": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ask For Location", "description": "Whether to prompt the user for their location." }, "language": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__language__Language" }, { "type": "null" } ], "description": "The detected language of the query." }, "spellcheck_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Spellcheck Off", "description": "Whether spellcheck is disabled for this query." }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "The country code for the query." }, "bad_results": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Bad Results", "description": "Whether the results are considered low quality." }, "should_fallback": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Should Fallback", "description": "Whether to fallback to alternative ranking." }, "lat": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lat", "description": "The latitude for location-based queries." }, "long": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long", "description": "The longitude for location-based queries." }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code", "description": "The postal code for location-based queries." }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "The city for location-based queries." }, "header_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Header Country", "description": "The country from request headers." }, "more_results_available": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "More Results Available", "description": "Whether more results are available for pagination." }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "The state/region for location-based queries." }, "custom_location_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Location Label", "description": "A custom label for the location." }, "reddit_cluster": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reddit Cluster", "description": "Reddit cluster identifier for discussion results." }, "summary_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary Key", "description": "Key to retrieve AI-generated summary for the query." }, "search_operators": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SearchOperators" }, { "type": "null" } ], "description": "Search operators that were detected and applied to the query." }, "related_queries": { "items": { "type": "string" }, "type": "array", "title": "Related Queries", "description": "Related queries for the query.", "default": [] } }, "type": "object", "required": [ "original" ], "title": "Query" }, "ResponseB91D37C29Ffe_app__models__products__search__v1__language__Language": { "properties": { "main": { "type": "string", "title": "Main", "description": "The main language seen in the string." } }, "type": "object", "required": [ "main" ], "title": "Language", "description": "A model representing a language." }, "ResponseB91D37C29Ffe_Discussions": { "properties": { "type": { "type": "string", "enum": [ "search" ], "const": "search", "title": "Type", "description": "The type identifying a discussion cluster. Currently the value is always search.", "default": "search" }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_DiscussionResult" }, "type": "array", "title": "Results", "description": "A list of discussion results." }, "mutated_by_goggles": { "type": "boolean", "title": "Mutated By Goggles", "description": "Whether the discussion results are changed by Goggles. The value is false by default.", "default": false } }, "type": "object", "required": [ "results" ], "title": "Discussions", "description": "A model representing a discussion cluster relevant to the query." }, "ResponseB91D37C29Ffe_DiscussionResult": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the web page." }, "url": { "type": "string", "title": "Url", "description": "The URL where the page is served." }, "is_source_local": { "type": "boolean", "title": "Is Source Local", "description": "Whether the result is from a local source.", "default": false }, "is_source_both": { "type": "boolean", "title": "Is Source Both", "description": "Whether the result is from both local and global sources.", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A description for the web page.", "default": "" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "A date representing when the web page was last fetched." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "language": { "type": "string", "title": "Language", "description": "The main language on the web search result.", "default": "en" }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the web page is family friendly.", "default": true }, "type": { "type": "string", "enum": [ "discussion" ], "const": "discussion", "title": "Type", "description": "The discussion result type identifier. The value is always discussion.", "default": "discussion" }, "subtype": { "type": "string", "title": "Subtype", "description": "A sub type identifying the web search result type.", "default": "generic" }, "is_live": { "type": "boolean", "title": "Is Live", "description": "Whether the web search result is currently live. Default value is false.", "default": false }, "deep_results": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_DeepResult" }, { "type": "null" } ], "description": "Gathered information on a web search result." }, "schemas": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Schemas", "description": "A list of schemas (structured data) extracted from the page. The schemas try to follow schema.org and will return anything we can extract from the HTML that can fit into these models." }, "meta_url": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Meta Url", "description": "Aggregated information on the URL associated with the web search result." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail of the web search result." }, "age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Age", "description": "A human-readable representation of the web search result’s age. For example, 2 days ago." }, "location": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationResult" }, { "type": "null" } ], "description": "The location details if the query relates to a restaurant." }, "restaurant": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationResult" }, { "type": "null" } ], "description": "Deprecated. Use location instead.", "deprecated": true }, "video": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoData" }, { "type": "null" } ], "description": "The video associated with the web search result." }, "movie": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_MovieData" }, { "type": "null" } ], "description": "The movie associated with the web search result." }, "faq": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__FAQ" }, { "type": "null" } ], "description": "Any frequently asked questions associated with the web search result." }, "qa": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_QAPage" }, { "type": "null" } ], "description": "Any question answer information associated with the web search result page." }, "book": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Book" }, { "type": "null" } ], "description": "Any book information associated with the web search result page." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "Rating found for the web search result page." }, "article": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Article" }, { "type": "null" } ], "description": "An article found for the web search result page." }, "product": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Product" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Review" }, { "type": "null" } ], "title": "Product", "description": "The main product and a review that is found on the web search result page." }, "product_cluster": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Product" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Review" } ] }, "type": "array" }, { "type": "null" } ], "title": "Product Cluster", "description": "A list of products and reviews that are found on the web search result page." }, "cluster_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cluster Type", "description": "A type representing a cluster. The value can be product_cluster." }, "cluster": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Result" }, "type": "array" }, { "type": "null" } ], "title": "Cluster", "description": "A list of web search results." }, "creative_work": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_CreativeWork" }, { "type": "null" } ], "description": "Aggregated information on the creative work found on the web search result." }, "music_recording": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_MusicRecording" }, { "type": "null" } ], "description": "Aggregated information on music recording found on the web search result." }, "review": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Review" }, { "type": "null" } ], "description": "Aggregated information on the review found on the web search result." }, "recipe": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Recipe" }, { "type": "null" } ], "description": "Aggregated information on a recipe found on the web search result page." }, "software": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Software" }, { "type": "null" } ], "description": "Aggregated information on a software product found on the web search result page." }, "organization": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Organization" }, { "type": "null" } ], "description": "Aggregated information on a organization found on the web search result page." }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Type", "description": "The content type associated with the search result page." }, "extra_snippets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Extra Snippets", "description": "A list of extra alternate snippets for the web search result." }, "icons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_PostprocessedIcon" }, "type": "array" }, { "type": "null" } ], "title": "Icons", "description": "Icons associated with the search result." }, "data": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ForumData" }, { "type": "null" } ], "description": "The enriched aggregated data for the relevant forum post." } }, "type": "object", "required": [ "title", "url" ], "title": "DiscussionResult", "description": "A discussion result. These are forum posts and discussions that are relevant to the search query." }, "ResponseB91D37C29Ffe_DeepResult": { "properties": { "news": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__NewsResult" }, "type": "array" }, { "type": "null" } ], "title": "News", "description": "A list of news results associated with the result." }, "buttons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ButtonResult" }, "type": "array" }, { "type": "null" } ], "title": "Buttons", "description": "A list of buttoned results associated with the result." }, "videos": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoResult" }, "type": "array" }, { "type": "null" } ], "title": "Videos", "description": "Videos associated with the result." }, "images": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Image" }, "type": "array" }, { "type": "null" } ], "title": "Images", "description": "Images associated with the result." } }, "type": "object", "title": "DeepResult", "description": "Aggregated deep results from news, social, videos and images." }, "ResponseB91D37C29Ffe_app__models__products__search__v1__shared__NewsResult": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the web page." }, "url": { "type": "string", "title": "Url", "description": "The URL where the page is served." }, "is_source_local": { "type": "boolean", "title": "Is Source Local", "description": "Whether the result is from a local source.", "default": false }, "is_source_both": { "type": "boolean", "title": "Is Source Both", "description": "Whether the result is from both local and global sources.", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A description for the web page.", "default": "" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "A date representing when the web page was last fetched." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "A language classification for the web page." }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the web page is family friendly.", "default": true }, "meta_url": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Meta Url", "description": "The aggregated information on the URL representing a news result." }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "description": "The source of the news." }, "breaking": { "type": "boolean", "title": "Breaking", "description": "Whether the news result is currently a breaking news.", "default": false }, "is_live": { "type": "boolean", "title": "Is Live", "description": "Whether the news result is currently live.", "default": false }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail associated with the news result." }, "age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Age", "description": "A human-readable representation of the news article’s age. For example, 2 days ago." }, "extra_snippets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Extra Snippets", "description": "A list of extra alternate snippets for the news search result." }, "icons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_PostprocessedIcon" }, "type": "array" }, { "type": "null" } ], "title": "Icons", "description": "Icons associated with the news result." } }, "type": "object", "required": [ "title", "url" ], "title": "NewsResult", "description": "A model representing news results." }, "ResponseB91D37C29Ffe_ButtonResult": { "properties": { "type": { "type": "string", "enum": [ "button_result" ], "const": "button_result", "title": "Type", "description": "A type identifying button result. The value is always button_result.", "default": "button_result" }, "title": { "type": "string", "title": "Title", "description": "The title of the result." }, "url": { "type": "string", "title": "Url", "description": "The URL for the button result." } }, "type": "object", "required": [ "title", "url" ], "title": "ButtonResult", "description": "A result which can be used as a button." }, "ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoResult": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the web page." }, "url": { "type": "string", "title": "Url", "description": "The URL where the page is served." }, "is_source_local": { "type": "boolean", "title": "Is Source Local", "description": "Whether the result is from a local source.", "default": false }, "is_source_both": { "type": "boolean", "title": "Is Source Both", "description": "Whether the result is from both local and global sources.", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A description for the web page.", "default": "" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "A date representing when the web page was last fetched." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "A language classification for the web page." }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the web page is family friendly.", "default": true }, "type": { "type": "string", "enum": [ "video_result" ], "const": "video_result", "title": "Type", "description": "The type identifying the video result. The value is always video_result.", "default": "video_result" }, "video": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoData", "description": "Meta data for the video." }, "meta_url": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__MetaUrl" }, { "type": "null" } ], "description": "Aggregated information on the URL." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail of the video." }, "age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Age", "description": "A human-readable representation of the video’s age. For example, 2 days ago." }, "publisher": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publisher", "description": "The publisher of the video." } }, "type": "object", "required": [ "title", "url", "video" ], "title": "VideoResult", "description": "A model representing a video result." }, "ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoData": { "properties": { "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duration", "description": "A time string representing the duration of the video. The format can be HH:MM:SS or MM:SS." }, "views": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Views", "description": "The number of views of the video." }, "creator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Creator", "description": "The creator of the video." }, "publisher": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publisher", "description": "The publisher of the video." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "A thumbnail associated with the video." }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "A list of tags associated with the video." }, "author": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "Author of the video." }, "requires_subscription": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Requires Subscription", "description": "Whether the video requires a subscription to watch." } }, "type": "object", "title": "VideoData", "description": "A model representing metadata gathered for a video." }, "ResponseB91D37C29Ffe_Image": { "properties": { "thumbnail": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail", "description": "The thumbnail associated with the image." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "The URL of the image." }, "properties": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ImageProperties" }, { "type": "null" } ], "description": "Metadata on the image." } }, "type": "object", "required": [ "thumbnail" ], "title": "Image", "description": "A model describing an image." }, "ResponseB91D37C29Ffe_ImageProperties": { "properties": { "url": { "type": "string", "title": "Url", "description": "The original image URL." }, "resized": { "type": "string", "title": "Resized", "description": "The URL for a better quality resized image." }, "placeholder": { "type": "string", "title": "Placeholder", "description": "The placeholder image URL." }, "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Height", "description": "The image height." }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Width", "description": "The image width." }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Format", "description": "The image format." }, "content_size": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Size", "description": "The image size." } }, "type": "object", "required": [ "url", "resized", "placeholder" ], "title": "ImageProperties", "description": "Metadata on an image." }, "ResponseB91D37C29Ffe_MovieData": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the movie." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A short plot summary for the movie." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "A URL serving a movie profile page." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "A thumbnail for a movie poster." }, "release": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release", "description": "The release date for the movie." }, "directors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Person" }, "type": "array" }, { "type": "null" } ], "title": "Directors", "description": "A list of people responsible for directing the movie." }, "actors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Person" }, "type": "array" }, { "type": "null" } ], "title": "Actors", "description": "A list of actors in the movie." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "Rating provided to the movie from various sources." }, "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duration", "description": "The runtime of the movie. The format is HH:MM:SS." }, "genre": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Genre", "description": "List of genres in which the movie can be classified." }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query", "description": "The query that resulted in the movie result." } }, "type": "object", "title": "MovieData", "description": "Aggregated data for a movie result." }, "ResponseB91D37C29Ffe_app__models__products__search__v1__shared__FAQ": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_QA" }, "type": "array", "title": "Items", "description": "A list of question/answer pairs." } }, "type": "object", "required": [ "items" ], "title": "FAQ", "description": "Frequently asked questions associated with a search result." }, "ResponseB91D37C29Ffe_QA": { "properties": { "question": { "type": "string", "title": "Question", "description": "The question being asked." }, "answer": { "type": "string", "title": "Answer", "description": "The answer to the question." }, "title": { "type": "string", "title": "Title", "description": "The title of the post." }, "url": { "type": "string", "title": "Url", "description": "The URL pointing to the post." }, "meta_url": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__MetaUrl" }, { "type": "null" } ], "description": "Aggregated information about the URL." } }, "type": "object", "required": [ "question", "answer", "title", "url" ], "title": "QA", "description": "A question/answer result." }, "ResponseB91D37C29Ffe_QAPage": { "properties": { "question": { "type": "string", "title": "Question", "description": "The question that is being asked." }, "answer": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Answer", "description": "An answer to the question." } }, "type": "object", "required": [ "question", "answer" ], "title": "QAPage", "description": "Aggregated result from a question answer page." }, "ResponseB91D37C29Ffe_Answer": { "properties": { "text": { "type": "string", "title": "Text", "description": "The main content of the answer." }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author", "description": "The name of the author of the answer." }, "upvoteCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Upvotecount", "description": "Number of upvotes on the answer." }, "downvoteCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Downvotecount", "description": "The number of downvotes on the answer." } }, "type": "object", "required": [ "text" ], "title": "Answer", "description": "A response representing an answer to a question on a forum." }, "ResponseB91D37C29Ffe_Book": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the book." }, "author": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Person" }, "type": "array", "title": "Author", "description": "The author of the book." }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date", "description": "The publishing date of the book." }, "price": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Price" }, { "type": "null" } ], "description": "The price of the book." }, "pages": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pages", "description": "The number of pages in the book." }, "publisher": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Person" }, { "type": "null" } ], "description": "The publisher of the book." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "A gathered rating from different sources associated with the book." } }, "type": "object", "required": [ "title", "author" ], "title": "Book", "description": "A model representing a book result." }, "ResponseB91D37C29Ffe_Price": { "properties": { "price": { "type": "string", "title": "Price", "description": "The price value in a given currency." }, "priceCurrency": { "type": "string", "title": "Pricecurrency", "description": "The currency of the price value." } }, "type": "object", "required": [ "price", "priceCurrency" ], "title": "Price", "description": "A model representing the price for an entity." }, "ResponseB91D37C29Ffe_Article": { "properties": { "author": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Person" }, "type": "array" }, { "type": "null" } ], "title": "Author", "description": "The author of the article." }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date", "description": "The date when the article was published." }, "publisher": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Organization" }, { "type": "null" } ], "description": "The name of the publisher for the article." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "A thumbnail associated with the article." }, "isAccessibleForFree": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Isaccessibleforfree", "description": "Whether the article is free to read or is behind a paywall." } }, "type": "object", "title": "Article", "description": "A model representing an article." }, "ResponseB91D37C29Ffe_Organization": { "properties": { "type": { "type": "string", "title": "Type", "description": "A type string identifying an organization. The value is always organization.", "default": "organization" }, "name": { "type": "string", "title": "Name", "description": "The name of the thing." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "A URL for the thing." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "Thumbnail associated with the thing." }, "contact_points": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ContactPoint" }, "type": "array" }, { "type": "null" } ], "title": "Contact Points", "description": "A list of contact points for the organization." } }, "type": "object", "required": [ "name" ], "title": "Organization", "description": "An entity responsible for another entity." }, "ResponseB91D37C29Ffe_ContactPoint": { "properties": { "type": { "type": "string", "title": "Type", "description": "A type string identifying a contact point. The value is always contact_point.", "default": "contact_point" }, "name": { "type": "string", "title": "Name", "description": "The name of the thing." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "A URL for the thing." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "Thumbnail associated with the thing." }, "telephone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telephone", "description": "The telephone number of the entity." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "The email address of the entity." } }, "type": "object", "required": [ "name" ], "title": "ContactPoint", "description": "A way to contact an entity." }, "ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Product": { "properties": { "type": { "type": "string", "enum": [ "Product" ], "const": "Product", "title": "Type", "description": "A string representing a product type. The value is always Product.", "default": "Product" }, "name": { "type": "string", "minLength": 1, "title": "Name", "description": "The name of the product." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "The URL of the product page." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "description": "The category of the product." }, "price": { "type": "string", "title": "Price", "description": "The price of the product." }, "thumbnail": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail", "description": "A thumbnail associated with the product." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The description of the product." }, "offers": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Offer" }, "type": "array", "title": "Offers", "description": "A list of offers available on the product.", "default": [] }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "A rating associated with the product." }, "gtin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gtin", "description": "A Global Trade Item Number (GTIN) for the product." }, "gtin8": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gtin8", "description": "The GTIN-8 (EAN/UCC-8) code of the product." }, "gtin12": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gtin12", "description": "The GTIN-12 (UPC) code of the product." }, "gtin13": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gtin13", "description": "The GTIN-13 (EAN/ISBN-13) code of the product." }, "gtin14": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gtin14", "description": "The GTIN-14 code of the product." } }, "type": "object", "required": [ "name", "price", "thumbnail" ], "title": "Product", "description": "A model representing a product." }, "ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Offer": { "properties": { "url": { "type": "string", "title": "Url", "description": "The URL where the offer can be found." }, "priceCurrency": { "type": "string", "title": "Pricecurrency", "description": "The currency in which the offer is made." }, "price": { "type": "string", "title": "Price", "description": "The price of the product currently on offer." } }, "type": "object", "required": [ "url", "priceCurrency", "price" ], "title": "Offer", "description": "An offer associated with a product." }, "ResponseB91D37C29Ffe_Review": { "properties": { "type": { "type": "string", "enum": [ "Review" ], "const": "Review", "title": "Type", "description": "A string representing review type. This is always Review.", "default": "Review" }, "name": { "type": "string", "title": "Name", "description": "The review title for the review." }, "thumbnail": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail", "description": "The thumbnail associated with the reviewer." }, "description": { "type": "string", "title": "Description", "description": "A description of the review (the text of the review itself)." }, "rating": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating", "description": "The ratings associated with the review." } }, "type": "object", "required": [ "name", "thumbnail", "description", "rating" ], "title": "Review", "description": "A model representing a review for an entity." }, "ResponseB91D37C29Ffe_Result": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the web page." }, "url": { "type": "string", "title": "Url", "description": "The URL where the page is served." }, "is_source_local": { "type": "boolean", "title": "Is Source Local", "description": "Whether the result is from a local source.", "default": false }, "is_source_both": { "type": "boolean", "title": "Is Source Both", "description": "Whether the result is from both local and global sources.", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A description for the web page.", "default": "" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "A date representing when the web page was last fetched." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "A language classification for the web page." }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the web page is family friendly.", "default": true } }, "type": "object", "required": [ "title", "url" ], "title": "Result", "description": "A model representing a web search result." }, "ResponseB91D37C29Ffe_CreativeWork": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name", "description": "The name of the creative work." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "A rating that is given to the creative work." }, "thumbnail": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail", "description": "A thumbnail associated with the creative work." } }, "type": "object", "required": [ "name", "thumbnail" ], "title": "CreativeWork", "description": "A creative work relevant to the query. An example can be enriched metadata for an app." }, "ResponseB91D37C29Ffe_MusicRecording": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name", "description": "The name of the song or album." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "The rating of the music." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "A thumbnail associated with the music." } }, "type": "object", "required": [ "name" ], "title": "MusicRecording", "description": "Result classified as a music label or a song." }, "ResponseB91D37C29Ffe_Recipe": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the recipe." }, "description": { "type": "string", "title": "Description", "description": "The description of the recipe." }, "thumbnail": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail", "description": "A thumbnail associated with the recipe." }, "url": { "type": "string", "title": "Url", "description": "The URL of the web page where the recipe was found." }, "domain": { "type": "string", "title": "Domain", "description": "The domain of the web page where the recipe was found." }, "favicon": { "type": "string", "title": "Favicon", "description": "The URL for the favicon of the web page where the recipe was found." }, "time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time", "description": "The total time required to cook the recipe." }, "prep_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prep Time", "description": "The preparation time for the recipe." }, "cook_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cook Time", "description": "The cooking time for the recipe." }, "ingredients": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ingredients", "description": "Ingredients required for the recipe." }, "instructions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_HowTo" }, "type": "array" }, { "type": "null" } ], "title": "Instructions", "description": "List of instructions for the recipe." }, "servings": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Servings", "description": "How many people the recipe serves." }, "calories": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Calories", "description": "Calorie count for the recipe." }, "publisher": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publisher", "description": "The publisher of the recipe." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "Aggregated information on the ratings associated with the recipe." }, "recipeCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recipecategory", "description": "The category of the recipe." }, "recipeCuisine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recipecuisine", "description": "The cuisine classification for the recipe." }, "video": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoData" }, { "type": "null" } ], "description": "Aggregated information on the cooking video associated with the recipe." } }, "type": "object", "required": [ "title", "description", "thumbnail", "url", "domain", "favicon" ], "title": "Recipe", "description": "Aggregated information on a recipe." }, "ResponseB91D37C29Ffe_HowTo": { "properties": { "text": { "type": "string", "title": "Text", "description": "The how to text." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "A name for the how to." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "A URL associated with the how to." }, "image": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Image", "description": "A list of image URLs associated with the how to." } }, "type": "object", "required": [ "text" ], "title": "HowTo", "description": "Aggregated information on a how to." }, "ResponseB91D37C29Ffe_Software": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The name of the software product." }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author", "description": "The author of software product." }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The latest version of the software product." }, "codeRepository": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Coderepository", "description": "The code repository where the software product is currently available or maintained." }, "homepage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Homepage", "description": "The home page of the software product." }, "datePublished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Datepublished", "description": "The date when the software product was published." }, "is_npm": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Npm", "description": "Whether the software product is available on npm." }, "is_pypi": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Pypi", "description": "Whether the software product is available on pypi." }, "stars": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Stars", "description": "The number of stars on the repository." }, "forks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Forks", "description": "The numbers of forks of the repository." }, "programmingLanguage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Programminglanguage", "description": "The programming language spread on the software product." } }, "type": "object", "title": "Software", "description": "A model representing a software entity." }, "ResponseB91D37C29Ffe_ForumData": { "properties": { "forum_name": { "type": "string", "title": "Forum Name", "description": "The name of the forum." }, "num_answers": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Num Answers", "description": "The number of answers to the post." }, "score": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Score", "description": "The score of the post on the forum." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "The title of the post on the forum." }, "question": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Question", "description": "The question asked in the forum post." }, "top_comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Top Comment", "description": "The top-rated comment under the forum post." } }, "type": "object", "required": [ "forum_name" ], "title": "ForumData", "description": "Defines a result from a discussion forum." }, "ResponseB91D37C29Ffe_app__models__products__search__v1__faq__FAQ": { "properties": { "type": { "type": "string", "enum": [ "faq" ], "const": "faq", "title": "Type", "description": "The FAQ result type identifier. The value is always faq.", "default": "faq" }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_QA" }, "type": "array", "title": "Results", "description": "A list of aggregated question answer results relevant to the query." } }, "type": "object", "required": [ "results" ], "title": "FAQ", "description": "Frequently asked questions relevant to the search query term." }, "ResponseB91D37C29Ffe_GraphInfobox": { "properties": { "type": { "type": "string", "enum": [ "graph" ], "const": "graph", "title": "Type", "description": "The type identifier for infoboxes. The value is always graph.", "default": "graph" }, "results": { "items": { "oneOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_GenericInfobox" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_QAInfobox" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_InfoboxPlace" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_InfoboxWithLocation" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_EntityInfobox" } ], "discriminator": { "propertyName": "subtype", "mapping": { "code": "#/components/schemas/ResponseB91D37C29Ffe_QAInfobox", "entity": "#/components/schemas/ResponseB91D37C29Ffe_EntityInfobox", "generic": "#/components/schemas/ResponseB91D37C29Ffe_GenericInfobox", "location": "#/components/schemas/ResponseB91D37C29Ffe_InfoboxWithLocation", "place": "#/components/schemas/ResponseB91D37C29Ffe_InfoboxPlace" } } }, "type": "array", "title": "Results", "description": "A list of infoboxes associated with the query." } }, "type": "object", "required": [ "results" ], "title": "GraphInfobox", "description": "Aggregated information on an entity shown as an infobox." }, "ResponseB91D37C29Ffe_QAInfobox": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the web page." }, "url": { "type": "string", "title": "Url", "description": "The URL where the page is served." }, "is_source_local": { "type": "boolean", "title": "Is Source Local", "description": "Whether the result is from a local source.", "default": false }, "is_source_both": { "type": "boolean", "title": "Is Source Both", "description": "Whether the result is from both local and global sources.", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A description for the web page.", "default": "" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "A date representing when the web page was last fetched." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "A language classification for the web page." }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the web page is family friendly.", "default": true }, "type": { "type": "string", "enum": [ "infobox" ], "const": "infobox", "title": "Type", "description": "The infobox result type identifier. The value is always infobox.", "default": "infobox" }, "position": { "type": "integer", "title": "Position", "description": "The position on a search result page." }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label", "description": "Any label associated with the entity." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "description": "Category classification for the entity." }, "long_desc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long Desc", "description": "A longer description for the entity." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail associated with the entity." }, "attributes": { "items": { "items": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "array", "maxItems": 2, "minItems": 2 }, "type": "array", "title": "Attributes", "description": "A list of attributes about the entity.", "default": [] }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider" }, "type": "array" }, { "type": "null" } ], "title": "Profiles", "description": "The profiles associated with the entity." }, "website_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website Url", "description": "The official website pertaining to the entity." }, "ratings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, "type": "array" }, { "type": "null" } ], "title": "Ratings", "description": "Any ratings given to the entity." }, "providers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider" }, "type": "array" }, { "type": "null" } ], "title": "Providers", "description": "A list of data sources for the entity." }, "distance": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Unit" }, { "type": "null" } ], "description": "A unit representing quantity relevant to the entity." }, "images": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, "type": "array" }, { "type": "null" } ], "title": "Images", "description": "A list of images relevant to the entity." }, "movie": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_MovieData" }, { "type": "null" } ], "description": "Any movie data relevant to the entity. Appears only when the result is a movie." }, "subtype": { "type": "string", "enum": [ "code" ], "const": "code", "title": "Subtype", "description": "The infobox subtype identifier. The value is always code.", "default": "code" }, "data": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_QAPage", "description": "The question and relevant answer." }, "meta_url": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__MetaUrl" }, { "type": "null" } ], "description": "Detailed information on the page containing the question and relevant answer." } }, "type": "object", "required": [ "title", "url", "position", "data" ], "title": "QAInfobox", "description": "A question answer infobox." }, "ResponseB91D37C29Ffe_EntityInfobox": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the web page." }, "url": { "type": "string", "title": "Url", "description": "The URL where the page is served." }, "is_source_local": { "type": "boolean", "title": "Is Source Local", "description": "Whether the result is from a local source.", "default": false }, "is_source_both": { "type": "boolean", "title": "Is Source Both", "description": "Whether the result is from both local and global sources.", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A description for the web page.", "default": "" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "A date representing when the web page was last fetched." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "A language classification for the web page." }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the web page is family friendly.", "default": true }, "type": { "type": "string", "enum": [ "infobox" ], "const": "infobox", "title": "Type", "description": "The infobox result type identifier. The value is always infobox.", "default": "infobox" }, "position": { "type": "integer", "title": "Position", "description": "The position on a search result page." }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label", "description": "Any label associated with the entity." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "description": "Category classification for the entity." }, "long_desc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long Desc", "description": "A longer description for the entity." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail associated with the entity." }, "attributes": { "items": { "items": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "array", "maxItems": 2, "minItems": 2 }, "type": "array", "title": "Attributes", "description": "A list of attributes about the entity.", "default": [] }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider" }, "type": "array" }, { "type": "null" } ], "title": "Profiles", "description": "The profiles associated with the entity." }, "website_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website Url", "description": "The official website pertaining to the entity." }, "ratings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, "type": "array" }, { "type": "null" } ], "title": "Ratings", "description": "Any ratings given to the entity." }, "providers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider" }, "type": "array" }, { "type": "null" } ], "title": "Providers", "description": "A list of data sources for the entity." }, "distance": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Unit" }, { "type": "null" } ], "description": "A unit representing quantity relevant to the entity." }, "images": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, "type": "array" }, { "type": "null" } ], "title": "Images", "description": "A list of images relevant to the entity." }, "movie": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_MovieData" }, { "type": "null" } ], "description": "Any movie data relevant to the entity. Appears only when the result is a movie." }, "subtype": { "type": "string", "enum": [ "entity" ], "const": "entity", "title": "Subtype", "description": "The infobox subtype identifier. The value is always entity.", "default": "entity" } }, "type": "object", "required": [ "title", "url", "position" ], "title": "EntityInfobox", "description": "Aggregated information on an entity from a knowledge graph." }, "ResponseB91D37C29Ffe_GenericInfobox": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the web page." }, "url": { "type": "string", "title": "Url", "description": "The URL where the page is served." }, "is_source_local": { "type": "boolean", "title": "Is Source Local", "description": "Whether the result is from a local source.", "default": false }, "is_source_both": { "type": "boolean", "title": "Is Source Both", "description": "Whether the result is from both local and global sources.", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A description for the web page.", "default": "" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "A date representing when the web page was last fetched." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "A language classification for the web page." }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the web page is family friendly.", "default": true }, "type": { "type": "string", "enum": [ "infobox" ], "const": "infobox", "title": "Type", "description": "The infobox result type identifier. The value is always infobox.", "default": "infobox" }, "position": { "type": "integer", "title": "Position", "description": "The position on a search result page." }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label", "description": "Any label associated with the entity." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "description": "Category classification for the entity." }, "long_desc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long Desc", "description": "A longer description for the entity." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail associated with the entity." }, "attributes": { "items": { "items": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "array", "maxItems": 2, "minItems": 2 }, "type": "array", "title": "Attributes", "description": "A list of attributes about the entity.", "default": [] }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider" }, "type": "array" }, { "type": "null" } ], "title": "Profiles", "description": "The profiles associated with the entity." }, "website_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website Url", "description": "The official website pertaining to the entity." }, "ratings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, "type": "array" }, { "type": "null" } ], "title": "Ratings", "description": "Any ratings given to the entity." }, "providers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider" }, "type": "array" }, { "type": "null" } ], "title": "Providers", "description": "A list of data sources for the entity." }, "distance": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Unit" }, { "type": "null" } ], "description": "A unit representing quantity relevant to the entity." }, "images": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, "type": "array" }, { "type": "null" } ], "title": "Images", "description": "A list of images relevant to the entity." }, "movie": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_MovieData" }, { "type": "null" } ], "description": "Any movie data relevant to the entity. Appears only when the result is a movie." }, "subtype": { "type": "string", "enum": [ "generic" ], "const": "generic", "title": "Subtype", "description": "The infobox subtype identifier. The value is always generic.", "default": "generic" }, "found_in_urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Found In Urls", "description": "List of URLs where the entity was found." } }, "type": "object", "required": [ "title", "url", "position" ], "title": "GenericInfobox", "description": "Aggregated information on a generic entity from a knowledge graph." }, "ResponseB91D37C29Ffe_InfoboxWithLocation": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the web page." }, "url": { "type": "string", "title": "Url", "description": "The URL where the page is served." }, "is_source_local": { "type": "boolean", "title": "Is Source Local", "description": "Whether the result is from a local source.", "default": false }, "is_source_both": { "type": "boolean", "title": "Is Source Both", "description": "Whether the result is from both local and global sources.", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A description for the web page.", "default": "" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "A date representing when the web page was last fetched." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "A language classification for the web page." }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the web page is family friendly.", "default": true }, "type": { "type": "string", "enum": [ "infobox" ], "const": "infobox", "title": "Type", "description": "The infobox result type identifier. The value is always infobox.", "default": "infobox" }, "position": { "type": "integer", "title": "Position", "description": "The position on a search result page." }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label", "description": "Any label associated with the entity." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "description": "Category classification for the entity." }, "long_desc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long Desc", "description": "A longer description for the entity." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail associated with the entity." }, "attributes": { "items": { "items": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "array", "maxItems": 2, "minItems": 2 }, "type": "array", "title": "Attributes", "description": "A list of attributes about the entity.", "default": [] }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider" }, "type": "array" }, { "type": "null" } ], "title": "Profiles", "description": "The profiles associated with the entity." }, "website_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website Url", "description": "The official website pertaining to the entity." }, "ratings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, "type": "array" }, { "type": "null" } ], "title": "Ratings", "description": "Any ratings given to the entity." }, "providers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider" }, "type": "array" }, { "type": "null" } ], "title": "Providers", "description": "A list of data sources for the entity." }, "distance": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Unit" }, { "type": "null" } ], "description": "A unit representing quantity relevant to the entity." }, "images": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, "type": "array" }, { "type": "null" } ], "title": "Images", "description": "A list of images relevant to the entity." }, "movie": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_MovieData" }, { "type": "null" } ], "description": "Any movie data relevant to the entity. Appears only when the result is a movie." }, "subtype": { "type": "string", "enum": [ "location" ], "const": "location", "title": "Subtype", "description": "The infobox subtype identifier. The value is always location.", "default": "location" }, "found_in_urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Found In Urls", "description": "List of URLs where the entity was found." }, "is_location": { "type": "boolean", "title": "Is Location", "description": "Whether the entity is a location.", "default": false }, "coordinates": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2 }, { "type": "null" } ], "title": "Coordinates", "description": "The coordinates of the location." }, "zoom_level": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Zoom Level", "description": "The map zoom level." }, "location": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationResult" }, { "type": "null" } ], "description": "The location result." } }, "type": "object", "required": [ "title", "url", "position" ], "title": "InfoboxWithLocation", "description": "An infobox with location." }, "ResponseB91D37C29Ffe_InfoboxPlace": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the web page." }, "url": { "type": "string", "title": "Url", "description": "The URL where the page is served." }, "is_source_local": { "type": "boolean", "title": "Is Source Local", "description": "Whether the result is from a local source.", "default": false }, "is_source_both": { "type": "boolean", "title": "Is Source Both", "description": "Whether the result is from both local and global sources.", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A description for the web page.", "default": "" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "A date representing when the web page was last fetched." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "A language classification for the web page." }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the web page is family friendly.", "default": true }, "type": { "type": "string", "enum": [ "infobox" ], "const": "infobox", "title": "Type", "description": "The infobox result type identifier. The value is always infobox.", "default": "infobox" }, "position": { "type": "integer", "title": "Position", "description": "The position on a search result page." }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label", "description": "Any label associated with the entity." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "description": "Category classification for the entity." }, "long_desc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long Desc", "description": "A longer description for the entity." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail associated with the entity." }, "attributes": { "items": { "items": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "array", "maxItems": 2, "minItems": 2 }, "type": "array", "title": "Attributes", "description": "A list of attributes about the entity.", "default": [] }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider" }, "type": "array" }, { "type": "null" } ], "title": "Profiles", "description": "The profiles associated with the entity." }, "website_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website Url", "description": "The official website pertaining to the entity." }, "ratings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, "type": "array" }, { "type": "null" } ], "title": "Ratings", "description": "Any ratings given to the entity." }, "providers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider" }, "type": "array" }, { "type": "null" } ], "title": "Providers", "description": "A list of data sources for the entity." }, "distance": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Unit" }, { "type": "null" } ], "description": "A unit representing quantity relevant to the entity." }, "images": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, "type": "array" }, { "type": "null" } ], "title": "Images", "description": "A list of images relevant to the entity." }, "movie": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_MovieData" }, { "type": "null" } ], "description": "Any movie data relevant to the entity. Appears only when the result is a movie." }, "subtype": { "type": "string", "enum": [ "place" ], "const": "place", "title": "Subtype", "description": "The infobox subtype identifier. The value is always place.", "default": "place" }, "found_in_urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Found In Urls", "description": "List of URLs where the entity was found." }, "is_location": { "type": "boolean", "title": "Is Location", "description": "Whether the entity is a location.", "default": false }, "coordinates": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2 }, { "type": "null" } ], "title": "Coordinates", "description": "The coordinates of the location." }, "zoom_level": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Zoom Level", "description": "The map zoom level." }, "location": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationResult", "description": "The location result." } }, "type": "object", "required": [ "title", "url", "position", "location" ], "title": "InfoboxPlace", "description": "An infobox for a place, such as a business." }, "ResponseB91D37C29Ffe_Locations": { "properties": { "type": { "type": "string", "enum": [ "locations" ], "const": "locations", "title": "Type", "description": "Location type identifier. The value is always locations.", "default": "locations" }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationResult" }, "type": "array", "title": "Results", "description": "An aggregated list of location sensitive results." }, "provider": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Provider", "description": "The provider of the location data." } }, "type": "object", "required": [ "results" ], "title": "Locations", "description": "A model representing location results." }, "ResponseB91D37C29Ffe_MixedResponse": { "properties": { "type": { "type": "string", "enum": [ "mixed" ], "const": "mixed", "title": "Type", "description": "The type representing the model mixed. The value is always mixed.", "default": "mixed" }, "main": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ResultReference" }, "type": "array" }, { "type": "null" } ], "title": "Main", "description": "The ranking order for the main section of the search result page." }, "top": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ResultReference" }, "type": "array" }, { "type": "null" } ], "title": "Top", "description": "The ranking order for the top section of the search result page." }, "side": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ResultReference" }, "type": "array" }, { "type": "null" } ], "title": "Side", "description": "The ranking order for the side section of the search result page." } }, "type": "object", "title": "MixedResponse", "description": "The ranking order of results on a search result page." }, "ResponseB91D37C29Ffe_News": { "properties": { "type": { "type": "string", "enum": [ "news" ], "const": "news", "title": "Type", "description": "The type of API result. The value is always news.", "default": "news" }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__NewsResult" }, "type": "array", "title": "Results", "description": "The list of news results." }, "mutated_by_goggles": { "type": "boolean", "title": "Mutated By Goggles", "description": "Whether the results are mutated by a goggle.", "default": false } }, "type": "object", "required": [ "results" ], "title": "News" }, "ResponseB91D37C29Ffe_Videos": { "properties": { "type": { "type": "string", "enum": [ "videos" ], "const": "videos", "title": "Type", "description": "The type of API result. The value is always videos.", "default": "videos" }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__VideoResult" }, "type": "array", "title": "Results", "description": "The list of video results." }, "mutated_by_goggles": { "type": "boolean", "title": "Mutated By Goggles", "description": "Whether the results are mutated by a goggle.", "default": false } }, "type": "object", "required": [ "results" ], "title": "Videos" }, "ResponseB91D37C29Ffe_Search": { "properties": { "type": { "type": "string", "enum": [ "search" ], "const": "search", "title": "Type", "description": "A type identifying web search results. The value is always search.", "default": "search" }, "results": { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SearchResult" }, "type": "array", "title": "Results", "description": "A list of search results." }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the results are family friendly.", "default": true } }, "type": "object", "required": [ "results" ], "title": "Search", "description": "A model representing a collection of web search results." }, "ResponseB91D37C29Ffe_SearchResult": { "properties": { "title": { "type": "string", "title": "Title", "description": "The title of the web page." }, "url": { "type": "string", "title": "Url", "description": "The URL where the page is served." }, "is_source_local": { "type": "boolean", "title": "Is Source Local", "description": "Whether the result is from a local source.", "default": false }, "is_source_both": { "type": "boolean", "title": "Is Source Both", "description": "Whether the result is from both local and global sources.", "default": false }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "A description for the web page.", "default": "" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age", "description": "The page’s date, based on its published or last modified date." }, "page_fetched": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Fetched", "description": "A date representing when the web page was last fetched." }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fetched Content Timestamp", "description": "The timestamp when the content was fetched." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "language": { "type": "string", "title": "Language", "description": "The main language on the web search result.", "default": "en" }, "family_friendly": { "type": "boolean", "title": "Family Friendly", "description": "Whether the web page is family friendly.", "default": true }, "type": { "type": "string", "enum": [ "search_result" ], "const": "search_result", "title": "Type", "description": "A type identifying a web search result. The value is always search_result.", "default": "search_result" }, "subtype": { "type": "string", "title": "Subtype", "description": "A sub type identifying the web search result type.", "default": "generic" }, "is_live": { "type": "boolean", "title": "Is Live", "description": "Whether the web search result is currently live. Default value is false.", "default": false }, "deep_results": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_DeepResult" }, { "type": "null" } ], "description": "Gathered information on a web search result." }, "schemas": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Schemas", "description": "A list of schemas (structured data) extracted from the page. The schemas try to follow schema.org and will return anything we can extract from the HTML that can fit into these models." }, "meta_url": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Meta Url", "description": "Aggregated information on the URL associated with the web search result." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail of the web search result." }, "age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Age", "description": "A human-readable representation of the web search result’s age. For example, 2 days ago." }, "location": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationResult" }, { "type": "null" } ], "description": "The location details if the query relates to a restaurant." }, "restaurant": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocationResult" }, { "type": "null" } ], "description": "Deprecated. Use location instead.", "deprecated": true }, "video": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoData" }, { "type": "null" } ], "description": "The video associated with the web search result." }, "movie": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_MovieData" }, { "type": "null" } ], "description": "The movie associated with the web search result." }, "faq": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__FAQ" }, { "type": "null" } ], "description": "Any frequently asked questions associated with the web search result." }, "qa": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_QAPage" }, { "type": "null" } ], "description": "Any question answer information associated with the web search result page." }, "book": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Book" }, { "type": "null" } ], "description": "Any book information associated with the web search result page." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "Rating found for the web search result page." }, "article": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Article" }, { "type": "null" } ], "description": "An article found for the web search result page." }, "product": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Product" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Review" }, { "type": "null" } ], "title": "Product", "description": "The main product and a review that is found on the web search result page." }, "product_cluster": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Product" }, { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Review" } ] }, "type": "array" }, { "type": "null" } ], "title": "Product Cluster", "description": "A list of products and reviews that are found on the web search result page." }, "cluster_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cluster Type", "description": "A type representing a cluster. The value can be product_cluster." }, "cluster": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Result" }, "type": "array" }, { "type": "null" } ], "title": "Cluster", "description": "A list of web search results." }, "creative_work": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_CreativeWork" }, { "type": "null" } ], "description": "Aggregated information on the creative work found on the web search result." }, "music_recording": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_MusicRecording" }, { "type": "null" } ], "description": "Aggregated information on music recording found on the web search result." }, "review": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Review" }, { "type": "null" } ], "description": "Aggregated information on the review found on the web search result." }, "recipe": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Recipe" }, { "type": "null" } ], "description": "Aggregated information on a recipe found on the web search result page." }, "software": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Software" }, { "type": "null" } ], "description": "Aggregated information on a software product found on the web search result page." }, "organization": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_Organization" }, { "type": "null" } ], "description": "Aggregated information on a organization found on the web search result page." }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Type", "description": "The content type associated with the search result page." }, "extra_snippets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Extra Snippets", "description": "A list of extra alternate snippets for the web search result." }, "icons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_PostprocessedIcon" }, "type": "array" }, { "type": "null" } ], "title": "Icons", "description": "Icons associated with the search result." } }, "type": "object", "required": [ "title", "url" ], "title": "SearchResult", "description": "Aggregated information on a web search result, relevant to the query." }, "ResponseB91D37C29Ffe_Summarizer": { "properties": { "type": { "type": "string", "enum": [ "summarizer" ], "const": "summarizer", "title": "Type", "description": "The type of result. The value is always summarizer.", "default": "summarizer" }, "key": { "type": "string", "title": "Key", "description": "The key to retrieve the full summary results." } }, "type": "object", "required": [ "key" ], "title": "Summarizer" }, "ResponseB91D37C29Ffe_RichHeaderCallback": { "properties": { "type": { "type": "string", "enum": [ "rich" ], "const": "rich", "title": "Type", "default": "rich" }, "hint": { "anyOf": [ { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ResponseCallback" }, { "type": "null" } ] } }, "type": "object", "title": "RichHeaderCallback" }, "ResponseB91D37C29Ffe_ResponseCallback": { "properties": { "vertical": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SearchAPIVertical", "description": "The vertical associated with the callback. For the full list of verticals supported see the Rich Vertical list." }, "callback_key": { "type": "string", "title": "Callback Key", "description": "The unique key for the callback." } }, "type": "object", "required": [ "vertical", "callback_key" ], "title": "ResponseCallback" }, "ProviderB91D37C29Ffe_WebSearchParameters": { "properties": { "q": { "type": "string", "maxLength": 600, "minLength": 1, "title": "Query", "description": "The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query." }, "country": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_SearchCountry", "title": "Search country", "description": "The 2 character country code where the search results come from.", "default": "US" }, "search_lang": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_Language-Input", "title": "Search language", "description": "The 2 or more character language code for which the search results are provided.", "default": "en" }, "ui_lang": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_MarketCodes", "title": "User interface language", "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.", "default": "en-US" }, "count": { "type": "integer", "maximum": 20, "minimum": 1, "title": "Count", "description": "

The number of search results returned in response.\nThe maximum is 20. The actual number delivered may be less than requested.\nCombine this parameter with offset to paginate search results.

\n

NOTE: Count only applies to web results.

", "default": 20 }, "offset": { "type": "integer", "maximum": 9, "minimum": 0, "title": "Offset", "description": "

The zero based offset that indicates number of search\nresult pages (count) to skip before returning the result.\nThe default is 0 and the maximum is 9.\nThe actual number delivered may be less than requested.

\n

Use this parameter along with the count parameter to page results.\nFor example, if your user interface displays 10 search results per page,\nset count to 10 and offset to 0 to get the first page of results.\nFor each subsequent page, increment offset by 1 (for example, 0, 1, 2).\nIt is possible for multiple pages to include some overlap in results.

", "default": 0 }, "safesearch": { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_app__models__general__SafeSearch", "title": "Safe search", "description": "

Filters search results for adult content. The following values are supported:

\n", "default": "moderate", "examples": [ "", "off", "moderate", "strict" ] }, "spellcheck": { "type": "boolean", "title": "Spellcheck", "description": "Whether to spell check provided query. If the spell checker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "default": true, "examples": [ "", true, false ] }, "freshness": { "type": "string", "title": "Freshness", "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "default": "", "examples": [ "", "pm", "2022-04-01to2022-07-30" ] }, "text_decorations": { "type": "boolean", "title": "Text decorations", "description": "Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters).", "default": true, "examples": [ "", true, false ] }, "result_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Result filter", "description": "

A comma delimited string of result types to include in the search response.\nNot specifying this parameter will return back all result types in search response where data is available\nand the plan has the corresponding option activated. The response always includes query and type to\nidentify any query modifications and response type respectively.\nAvailable result filter values are: discussions, faq, infobox, news, query, summarizer, videos, web, locations.

\n

NOTE: count param only applies to web results.

", "examples": [ "", "web", "videos", "web,videos" ] }, "units": { "anyOf": [ { "$ref": "#/components/schemas/ProviderB91D37C29Ffe_MeasurementUnit" }, { "type": "null" } ], "title": "Units", "description": "

The measurement units. The following values are supported:

\n", "examples": [ "", "metric", "imperial" ] }, "goggles_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Goggles id", "description": "Goggles act as a custom re-ranking on top of Brave’s search index. For more details, refer to the Goggles repository. This parameter is deprecated. Please use the goggles parameter.", "deprecated": true }, "goggles": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Goggles", "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles." }, "extra_snippets": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Extra snippets", "description": "A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts.", "examples": [ "", true, false ] }, "summary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Summary", "description": "This parameter enables summary key generation in web search results. This is required for summarizer to be enabled.", "examples": [ "", true, false ] }, "enable_rich_callback": { "type": "boolean", "title": "Enable Rich Callback", "description": "

Enable rich callback.\nAllows you to get real time rich results via a callback URL when they are relevant to your query.

\n

NOTE: Requires Search plan.

", "default": false, "examples": [ "", false, true ] }, "include_fetch_metadata": { "type": "boolean", "title": "Include Fetch Metadata", "description": "Include fetch metadata.", "default": false, "examples": [ "", false, true ] }, "operators": { "type": "boolean", "title": "Operators", "description": "Whether to apply search operators", "default": true, "examples": [ "", true, false ] } }, "type": "object", "required": [ "q" ], "title": "WebSearchParameters" } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "links": {}, "callbacks": {}, "pathItems": {} }, "info": { "description": "", "title": "Brave Search", "version": "1", "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" } }, "x-aisa-configured-paths": [ "/apis/v1/brave/images/search", "/apis/v1/brave/llm/context", "/apis/v1/brave/local/descriptions", "/apis/v1/brave/local/place_search", "/apis/v1/brave/local/pois", "/apis/v1/brave/news/search", "/apis/v1/brave/spellcheck/search", "/apis/v1/brave/suggest/search", "/apis/v1/brave/videos/search", "/apis/v1/brave/web/rich", "/apis/v1/brave/web/search" ], "x-aisa-document": { "facts_hash": "8627d7bc05db287888574873d586ce7dca25f9fa7b4a266cb71760e824597bfc", "generator_version": "3", "protocol_version": "1", "schema_version": "1", "composer_version": "20", "response_pending": [], "document_hash": "sha256:dd3bf51bf816c65187edaf986eabe02a048ea79407f7f5e64e18c08fd29983cf" }, "x-aisa-plans": { "builder": 1.0, "display_plan": "payg", "payg": 1.0, "similarweb_payg": 1.0, "team": 1.0, "version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb" }, "x-aisa-provider": "brave-search", "x-aisa-catalogs": { "brave-search": { "title": "Brave Search", "description": "", "x-aisa-document": { "facts_hash": "8627d7bc05db287888574873d586ce7dca25f9fa7b4a266cb71760e824597bfc", "generator_version": "3", "protocol_version": "1", "schema_version": "1" }, "x-aisa-plans": { "builder": 1.0, "display_plan": "payg", "payg": 1.0, "similarweb_payg": 1.0, "team": 1.0, "version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb" }, "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" } } } } }, "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "openapi": "3.1.0", "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "https://api.aisa.one" } ], "paths": { "/apis/v1/brave/images/search": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "any_brave_search_apis_v1_brave_images_search", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_ImageSearchApiResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Image Search", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "afe9e70ae48d" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/images/search", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_images_search", "method": "ANY", "path": "/apis/v1/brave/images/search" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "count", "in": "query", "required": false, "description": "

The number of search results returned in response. The maximum is 200. The actual number delivered may be less than requested.

\n

NOTE: Image search is not paginated and has no offset parameter. Raise count to get more results.

", "schema": { "type": "integer", "maximum": 200, "minimum": 1, "description": "

The number of search results returned in response. The maximum is 200. The actual number delivered may be less than requested.

\n

NOTE: Image search is not paginated and has no offset parameter. Raise count to get more results.

", "default": 50, "title": "Count" }, "deprecated": false }, { "name": "country", "in": "query", "required": false, "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries and ALL for worldwide.", "schema": { "allOf": [ { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, { "default": "US" } ], "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries and ALL for worldwide." }, "deprecated": false }, { "name": "q", "in": "query", "required": true, "description": "The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "schema": { "type": "string", "minLength": 1, "maxLength": 400, "description": "The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "title": "Q" }, "deprecated": false }, { "name": "safesearch", "in": "query", "required": false, "description": "

Filters search results for adult content. The following values are supported:

\n", "schema": { "allOf": [ { "type": "string", "enum": [ "off", "strict" ], "title": "SafeSearch" }, { "default": "strict" } ], "title": "Safe search", "description": "

Filters search results for adult content. The following values are supported:

\n", "examples": [ "", "off", "strict" ] }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": "off" }, "2": { "value": "strict" } } }, { "name": "search_lang", "in": "query", "required": false, "description": "The search language preference. The 2 or more character language code for which the search results are provided.", "schema": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "description": "The search language preference. The 2 or more character language code for which the search results are provided." }, "deprecated": false }, { "name": "spellcheck", "in": "query", "required": false, "description": "Whether to spell check provided query. If the spell checker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "schema": { "type": "boolean", "description": "Whether to spell check provided query. If the spell checker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "examples": [ "", true, false ], "default": true, "title": "Spellcheck" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } } } ], "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:46e884f9c28c3eb08b3d7fbd3818f1c6e73a41a276383116bfd1b128f51c7b50" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/any_brave_search_apis_v1_brave_images_search" } }, "/apis/v1/brave/llm/context": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "get_any_brave_search_apis_v1_brave_llm_context", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LLMContextAPIResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "LLM Context", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET", "POST" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "54239616744a" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/llm/context", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_llm_context", "method": "ANY", "path": "/apis/v1/brave/llm/context" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "x-loc-city", "in": "header", "required": false, "description": "The generic name of the client city", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The generic name of the client city", "title": "X-Loc-City" }, "deprecated": false, "examples": { "City in USA": { "value": "Ann Arbor" } } }, { "name": "x-loc-country", "in": "header", "required": false, "description": "The two letter country code for the client’s country. For a list of country codes, see ISO 3166-1 alpha-2", "schema": { "anyOf": [ { "type": "string", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "Country" }, { "type": "null" } ], "description": "The two letter country code for the client’s country. For a list of country codes, see ISO 3166-1 alpha-2", "title": "X-Loc-Country" }, "deprecated": false, "examples": { "Country alpha-2 code": { "value": "US" } } }, { "name": "x-loc-lat", "in": "header", "required": false, "description": "The latitude of the client’s geographical location in degrees, to provide relevant local results. The latitude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees.", "schema": { "anyOf": [ { "type": "number", "maximum": 90, "minimum": -90 }, { "type": "null" } ], "description": "The latitude of the client’s geographical location in degrees, to provide relevant local results. The latitude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees.", "title": "X-Loc-Lat" }, "deprecated": false, "examples": { "None": {} } }, { "name": "x-loc-long", "in": "header", "required": false, "description": "The longitude of the client’s geographical location in degrees, to provide relevant local results. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0 degrees.", "schema": { "anyOf": [ { "type": "number", "maximum": 180, "minimum": -180 }, { "type": "null" } ], "description": "The longitude of the client’s geographical location in degrees, to provide relevant local results. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0 degrees.", "title": "X-Loc-Long" }, "deprecated": false, "examples": { "None": {} } }, { "name": "x-loc-postal-code", "in": "header", "required": false, "description": "The client’s postal code", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The client’s postal code", "title": "X-Loc-Postal-Code" }, "deprecated": false, "examples": { "Postal code in Ann Harbor, Michigan, US": { "value": "48105" } } }, { "name": "x-loc-state", "in": "header", "required": false, "description": "A code which could be up to three characters, that represent the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A code which could be up to three characters, that represent the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "title": "X-Loc-State" }, "deprecated": false, "examples": { "Michigan State/Region code in USA": { "value": "MI" } } }, { "name": "x-loc-state-name", "in": "header", "required": false, "description": "The name of the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "title": "X-Loc-State-Name" }, "deprecated": false, "examples": { "Michigan generic state name in USA": { "value": "Michigan" } } }, { "name": "context_threshold_mode", "in": "query", "required": false, "description": "The mode to use to determine the threshold for including content in context.", "schema": { "anyOf": [ { "type": "string", "enum": [ "disabled", "strict", "lenient", "balanced" ], "title": "SummarizerContextThresholdMode" }, { "type": "null" } ], "description": "The mode to use to determine the threshold for including content in context.", "title": "Context Threshold Mode" }, "deprecated": false }, { "name": "count", "in": "query", "required": false, "description": "The maximum number of search results considered to select the LLM context data. The default is 20 and the maximum is 50.", "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "The maximum number of search results considered to select the LLM context data. The default is 20 and the maximum is 50.", "default": 20, "title": "Count" }, "deprecated": false }, { "name": "country", "in": "query", "required": false, "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries.", "schema": { "allOf": [ { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, { "default": "US" } ], "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries." }, "deprecated": false }, { "name": "enable_local", "in": "query", "required": false, "description": "Whether to enable local recall. Not setting this value means auto-detect: local recall is used if a location is provided (X-Loc-Lat with X-Loc-Long, or X-Loc-City).", "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether to enable local recall. Not setting this value means auto-detect: local recall is used if a location is provided (X-Loc-Lat with X-Loc-Long, or X-Loc-City).", "title": "Enable Local" }, "deprecated": false }, { "name": "enable_source_metadata", "in": "query", "required": false, "description": "Enable source metadata enrichment (site_name, favicon, thumbnail, description, fetched_content_timestamp) in the sources attribute of the response.", "schema": { "type": "boolean", "description": "Enable source metadata enrichment (site_name, favicon, thumbnail, description, fetched_content_timestamp) in the sources attribute of the response.", "default": false, "title": "Enable Source Metadata" }, "deprecated": false }, { "name": "freshness", "in": "query", "required": false, "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "schema": { "type": "string", "title": "Freshness", "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "examples": [ "", "pm", "2022-04-01to2022-07-30" ], "default": "" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": "pm" }, "2": { "value": "2022-04-01to2022-07-30" } } }, { "name": "goggles", "in": "query", "required": false, "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles.", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles.", "title": "Goggles" }, "deprecated": false, "examples": { "Prioritizes domains popular with the Hacker News": { "value": "https://raw.githubusercontent.com/brave/goggles-quickstart/main/goggles/hacker_news.goggle" }, "Social media blocker": { "value": "! name: Social Networks\n! description: Removes social networks\n! public: true\n! author: Average Joe\n! avatar: #de0320\n$discard,site=facebook.com\n$discard,site=x.com\n$discard,site=instagram.com" } } }, { "name": "maximum_number_of_snippets", "in": "query", "required": false, "description": "Maximum number of different snippets (or chunks of text) to include in LLM context. The default is 50 and maximum is 256.", "schema": { "type": "integer", "maximum": 256, "minimum": 1, "description": "Maximum number of different snippets (or chunks of text) to include in LLM context. The default is 50 and maximum is 256.", "default": 50, "title": "Maximum Number Of Snippets" }, "deprecated": false }, { "name": "maximum_number_of_snippets_per_url", "in": "query", "required": false, "description": "Maximum number of snippets to include per URL. The default is 50 and maximum is 100.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Maximum number of snippets to include per URL. The default is 50 and maximum is 100.", "default": 50, "title": "Maximum Number Of Snippets Per Url" }, "deprecated": false }, { "name": "maximum_number_of_tokens", "in": "query", "required": false, "description": "Approximate maximum number of tokens to include in context. The default is 8192 and maximum is 32768.", "schema": { "type": "integer", "maximum": 32768, "minimum": 1024, "description": "Approximate maximum number of tokens to include in context. The default is 8192 and maximum is 32768.", "default": 8192, "title": "Maximum Number Of Tokens" }, "deprecated": false }, { "name": "maximum_number_of_tokens_per_url", "in": "query", "required": false, "description": "Maximum number of tokens to include per URL. The default is 4096 and maximum is 8192.", "schema": { "type": "integer", "maximum": 8192, "minimum": 512, "description": "Maximum number of tokens to include per URL. The default is 4096 and maximum is 8192.", "default": 4096, "title": "Maximum Number Of Tokens Per Url" }, "deprecated": false }, { "name": "maximum_number_of_urls", "in": "query", "required": false, "description": "Maximum number of different URLs to include in LLM context.", "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Maximum number of different URLs to include in LLM context.", "default": 20, "title": "Maximum Number Of Urls" }, "deprecated": false }, { "name": "q", "in": "query", "required": true, "description": "The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query.", "schema": { "type": "string", "minLength": 1, "maxLength": 600, "description": "The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query.", "title": "Q" }, "deprecated": false }, { "name": "safesearch", "in": "query", "required": false, "description": "

Filters results for adult content. The following values are supported:

\n\n

When not set, no filtering is applied — except for local recall, which stays strict.

", "schema": { "anyOf": [ { "type": "string", "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch" }, { "type": "null" } ], "title": "Safe search", "description": "

Filters results for adult content. The following values are supported:

\n\n

When not set, no filtering is applied — except for local recall, which stays strict.

" }, "deprecated": false }, { "name": "search_lang", "in": "query", "required": false, "description": "The search language preference. The 2 or more character language code for which the search results are provided.", "schema": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "description": "The search language preference. The 2 or more character language code for which the search results are provided." }, "deprecated": false }, { "name": "spellcheck", "in": "query", "required": false, "description": "Whether to enable spellcheck on the query.", "schema": { "type": "boolean", "description": "Whether to enable spellcheck on the query.", "default": true, "title": "Spellcheck" }, "deprecated": false } ], "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:f17a5a9908e7e9b45508fcbf3c6163d4c4d7e0e37ec43a49a2cf7c92096643bb" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/get_any_brave_search_apis_v1_brave_llm_context" }, "post": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "post_any_brave_search_apis_v1_brave_llm_context", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LLMContextAPIResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "LLM Context", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET", "POST" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "54239616744a" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/llm/context", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_llm_context", "method": "ANY", "path": "/apis/v1/brave/llm/context" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "x-loc-city", "in": "header", "required": false, "description": "The generic name of the client city", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The generic name of the client city", "title": "X-Loc-City" }, "deprecated": false, "examples": { "City in USA": { "value": "Ann Arbor" } } }, { "name": "x-loc-country", "in": "header", "required": false, "description": "The two letter country code for the client’s country. For a list of country codes, see ISO 3166-1 alpha-2", "schema": { "anyOf": [ { "type": "string", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "Country" }, { "type": "null" } ], "description": "The two letter country code for the client’s country. For a list of country codes, see ISO 3166-1 alpha-2", "title": "X-Loc-Country" }, "deprecated": false, "examples": { "Country alpha-2 code": { "value": "US" } } }, { "name": "x-loc-lat", "in": "header", "required": false, "description": "The latitude of the client’s geographical location in degrees, to provide relevant local results. The latitude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees.", "schema": { "anyOf": [ { "type": "number", "maximum": 90, "minimum": -90 }, { "type": "null" } ], "description": "The latitude of the client’s geographical location in degrees, to provide relevant local results. The latitude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees.", "title": "X-Loc-Lat" }, "deprecated": false, "examples": { "None": {} } }, { "name": "x-loc-long", "in": "header", "required": false, "description": "The longitude of the client’s geographical location in degrees, to provide relevant local results. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0 degrees.", "schema": { "anyOf": [ { "type": "number", "maximum": 180, "minimum": -180 }, { "type": "null" } ], "description": "The longitude of the client’s geographical location in degrees, to provide relevant local results. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0 degrees.", "title": "X-Loc-Long" }, "deprecated": false, "examples": { "None": {} } }, { "name": "x-loc-postal-code", "in": "header", "required": false, "description": "The client’s postal code", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The client’s postal code", "title": "X-Loc-Postal-Code" }, "deprecated": false, "examples": { "Postal code in Ann Harbor, Michigan, US": { "value": "48105" } } }, { "name": "x-loc-state", "in": "header", "required": false, "description": "A code which could be up to three characters, that represent the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A code which could be up to three characters, that represent the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "title": "X-Loc-State" }, "deprecated": false, "examples": { "Michigan State/Region code in USA": { "value": "MI" } } }, { "name": "x-loc-state-name", "in": "header", "required": false, "description": "The name of the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "title": "X-Loc-State-Name" }, "deprecated": false, "examples": { "Michigan generic state name in USA": { "value": "Michigan" } } } ], "requestBody": { "required": true, "description": "", "content": { "application/json": { "schema": { "properties": { "q": { "type": "string", "maxLength": 600, "minLength": 1, "title": "Q", "description": "The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query." }, "country": { "allOf": [ { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, { "default": "US" } ], "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries." }, "search_lang": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "description": "The search language preference. The 2 or more character language code for which the search results are provided." }, "count": { "type": "integer", "maximum": 50, "minimum": 1, "title": "Count", "description": "The maximum number of search results considered to select the LLM context data. The default is 20 and the maximum is 50.", "default": 20 }, "safesearch": { "anyOf": [ { "type": "string", "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch" }, { "type": "null" } ], "title": "Safe search", "description": "

Filters results for adult content. The following values are supported:

\n\n

When not set, no filtering is applied — except for local recall, which stays strict.

" }, "spellcheck": { "type": "boolean", "title": "Spellcheck", "description": "Whether to enable spellcheck on the query.", "default": true }, "maximum_number_of_urls": { "type": "integer", "maximum": 50, "minimum": 1, "title": "Maximum Number Of Urls", "description": "Maximum number of different URLs to include in LLM context.", "default": 20 }, "maximum_number_of_tokens": { "type": "integer", "maximum": 32768, "minimum": 1024, "title": "Maximum Number Of Tokens", "description": "Approximate maximum number of tokens to include in context. The default is 8192 and maximum is 32768.", "default": 8192 }, "maximum_number_of_snippets": { "type": "integer", "maximum": 256, "minimum": 1, "title": "Maximum Number Of Snippets", "description": "Maximum number of different snippets (or chunks of text) to include in LLM context. The default is 50 and maximum is 256.", "default": 50 }, "context_threshold_mode": { "anyOf": [ { "type": "string", "enum": [ "disabled", "strict", "lenient", "balanced" ], "title": "SummarizerContextThresholdMode" }, { "type": "null" } ], "description": "The mode to use to determine the threshold for including content in context." }, "maximum_number_of_tokens_per_url": { "type": "integer", "maximum": 8192, "minimum": 512, "title": "Maximum Number Of Tokens Per Url", "description": "Maximum number of tokens to include per URL. The default is 4096 and maximum is 8192.", "default": 4096 }, "maximum_number_of_snippets_per_url": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Maximum Number Of Snippets Per Url", "description": "Maximum number of snippets to include per URL. The default is 50 and maximum is 100.", "default": 50 }, "goggles": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Goggles", "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles." }, "freshness": { "type": "string", "title": "Freshness", "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "default": "", "examples": [ "", "pm", "2022-04-01to2022-07-30" ] }, "enable_local": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Local", "description": "Whether to enable local recall. Not setting this value means auto-detect: local recall is used if a location is provided (X-Loc-Lat with X-Loc-Long, or X-Loc-City)." }, "enable_source_metadata": { "type": "boolean", "title": "Enable Source Metadata", "description": "Enable source metadata enrichment (site_name, favicon, thumbnail, description, fetched_content_timestamp) in the sources attribute of the response.", "default": false } }, "type": "object", "required": [ "q" ], "title": "LLMContextParameters" } } } }, "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:f17a5a9908e7e9b45508fcbf3c6163d4c4d7e0e37ec43a49a2cf7c92096643bb" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/post_any_brave_search_apis_v1_brave_llm_context" } }, "/apis/v1/brave/local/descriptions": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "any_brave_search_apis_v1_brave_local_descriptions", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocalDescriptionsSearchApiResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "POI Descriptions", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "303b2a73fddc" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/local/descriptions", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_local_descriptions", "method": "ANY", "path": "/apis/v1/brave/local/descriptions" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "ids", "in": "query", "required": true, "description": "A list of unique identifiers for the location. The ids are valid only for 8 hours.", "schema": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 20, "description": "A list of unique identifiers for the location. The ids are valid only for 8 hours.", "title": "Ids" }, "deprecated": false } ], "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:013196fc8373fe4297fe98764464142b467e72ca7a0606d156900e1064cab7c7" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/any_brave_search_apis_v1_brave_local_descriptions" } }, "/apis/v1/brave/local/place_search": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "any_brave_search_apis_v1_brave_local_place_search", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocalPlaceSearchApiResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Place Search", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "2e43591a716a" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/local/place_search", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_local_place_search", "method": "ANY", "path": "/apis/v1/brave/local/place_search" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "count", "in": "query", "required": false, "description": "Number of results to return. The maximum is 100.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of results to return. The maximum is 100.", "default": 20, "title": "Count" }, "deprecated": false }, { "name": "country", "in": "query", "required": false, "description": "Two-letter country code (ISO 3166-1 alpha-2) to scope the search.", "schema": { "allOf": [ { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, { "default": "US" } ], "description": "Two-letter country code (ISO 3166-1 alpha-2) to scope the search." }, "deprecated": false }, { "name": "geoloc", "in": "query", "required": false, "description": "Optional geolocation of the user in the format <latitude>x<longitude>. Used to calculate distance values in results.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional geolocation of the user in the format <latitude>x<longitude>. Used to calculate distance values in results.", "title": "Geoloc" }, "deprecated": false }, { "name": "latitude", "in": "query", "required": false, "description": "Latitude of the geographical coordinates.", "schema": { "anyOf": [ { "type": "number", "maximum": 90, "minimum": -90 }, { "type": "null" } ], "description": "Latitude of the geographical coordinates.", "title": "Latitude" }, "deprecated": false }, { "name": "location", "in": "query", "required": false, "description": "

Location string to search for points of interest in an area.\nThis is alternative to the latitude and longitude parameters.

\n", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "

Location string to search for points of interest in an area.\nThis is alternative to the latitude and longitude parameters.

\n", "title": "Location" }, "deprecated": false }, { "name": "longitude", "in": "query", "required": false, "description": "Longitude of the geographical coordinates.", "schema": { "anyOf": [ { "type": "number", "maximum": 180, "minimum": -180 }, { "type": "null" } ], "description": "Longitude of the geographical coordinates.", "title": "Longitude" }, "deprecated": false }, { "name": "q", "in": "query", "required": false, "description": "Query string to search for points of interest in an area. If no q is provided, the endpoint will return general points of interest in the given area.", "schema": { "type": "string", "description": "Query string to search for points of interest in an area. If no q is provided, the endpoint will return general points of interest in the given area.", "default": "", "title": "Q" }, "deprecated": false }, { "name": "radius", "in": "query", "required": false, "description": "Search radius bias around the given coordinates, in meters. NOTE: This is not strictly the radius of the search (nor the resulting radius of the results), but rather a bias towards results that are closer to the given coordinates. Search is performed globally if no radius is provided.", "schema": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "description": "Search radius bias around the given coordinates, in meters. NOTE: This is not strictly the radius of the search (nor the resulting radius of the results), but rather a bias towards results that are closer to the given coordinates. Search is performed globally if no radius is provided.", "title": "Radius" }, "deprecated": false }, { "name": "safesearch", "in": "query", "required": false, "description": "Safe search level for the query results.", "schema": { "allOf": [ { "type": "string", "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch" }, { "default": "strict" } ], "description": "Safe search level for the query results." }, "deprecated": false }, { "name": "search_lang", "in": "query", "required": false, "description": "Language for the search results.", "schema": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "description": "Language for the search results." }, "deprecated": false }, { "name": "spellcheck", "in": "query", "required": false, "description": "Whether to apply spellcheck before executing the search.", "schema": { "type": "boolean", "description": "Whether to apply spellcheck before executing the search.", "default": true, "title": "Spellcheck" }, "deprecated": false }, { "name": "ui_lang", "in": "query", "required": false, "description": "User interface language for the response. Usually <language>-<region>.", "schema": { "allOf": [ { "type": "string", "enum": [ "es-AR", "en-AU", "de-AT", "nl-BE", "fr-BE", "pt-BR", "en-CA", "fr-CA", "es-CL", "da-DK", "fi-FI", "fr-FR", "de-DE", "el-GR", "zh-HK", "en-IN", "en-ID", "it-IT", "ja-JP", "ko-KR", "en-MY", "es-MX", "nl-NL", "en-NZ", "no-NO", "zh-CN", "pl-PL", "en-PH", "ru-RU", "en-ZA", "es-ES", "sv-SE", "fr-CH", "de-CH", "zh-TW", "tr-TR", "en-GB", "en-US", "es-US" ], "title": "MarketCodes" }, { "default": "en-US" } ], "description": "User interface language for the response. Usually <language>-<region>." }, "deprecated": false }, { "name": "units", "in": "query", "required": false, "description": "Units of measurement for distance values: metric is kilometres, imperial is miles.", "schema": { "allOf": [ { "type": "string", "enum": [ "imperial", "metric" ], "title": "MeasurementUnit" }, { "default": "metric" } ], "description": "Units of measurement for distance values: metric is kilometres, imperial is miles." }, "deprecated": false } ], "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:8809108c967fe28f4089cfc50b21ff18a2732bbcba2cba72c095bf38f1132628" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/any_brave_search_apis_v1_brave_local_place_search" } }, "/apis/v1/brave/local/pois": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "any_brave_search_apis_v1_brave_local_pois", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_LocalPoiSearchApiResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Local POIs", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "7e981cf1b32c" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/local/pois", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_local_pois", "method": "ANY", "path": "/apis/v1/brave/local/pois" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "x-loc-lat", "in": "header", "required": false, "description": "The latitude of the client’s geographical location in degrees, to provide relevant local results. The latitude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees.", "schema": { "anyOf": [ { "type": "number", "maximum": 90, "minimum": -90 }, { "type": "null" } ], "description": "The latitude of the client’s geographical location in degrees, to provide relevant local results. The latitude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees.", "title": "X-Loc-Lat" }, "deprecated": false }, { "name": "x-loc-long", "in": "header", "required": false, "description": "The longitude of the client’s geographical location in degrees, to provide relevant local results. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0 degrees.", "schema": { "anyOf": [ { "type": "number", "maximum": 180, "minimum": -180 }, { "type": "null" } ], "description": "The longitude of the client’s geographical location in degrees, to provide relevant local results. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0 degrees.", "title": "X-Loc-Long" }, "deprecated": false }, { "name": "ids", "in": "query", "required": true, "description": "A list of unique identifiers for the location. The ids are valid only for 8 hours.", "schema": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 20, "description": "A list of unique identifiers for the location. The ids are valid only for 8 hours.", "title": "Ids" }, "deprecated": false }, { "name": "search_lang", "in": "query", "required": false, "description": "The search language preference. The 2 or more character language code for which the search results are provided.", "schema": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "description": "The search language preference. The 2 or more character language code for which the search results are provided." }, "deprecated": false }, { "name": "ui_lang", "in": "query", "required": false, "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.", "schema": { "allOf": [ { "type": "string", "enum": [ "es-AR", "en-AU", "de-AT", "nl-BE", "fr-BE", "pt-BR", "en-CA", "fr-CA", "es-CL", "da-DK", "fi-FI", "fr-FR", "de-DE", "el-GR", "zh-HK", "en-IN", "en-ID", "it-IT", "ja-JP", "ko-KR", "en-MY", "es-MX", "nl-NL", "en-NZ", "no-NO", "zh-CN", "pl-PL", "en-PH", "ru-RU", "en-ZA", "es-ES", "sv-SE", "fr-CH", "de-CH", "zh-TW", "tr-TR", "en-GB", "en-US", "es-US" ], "title": "MarketCodes" }, { "default": "en-US" } ], "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110." }, "deprecated": false }, { "name": "units", "in": "query", "required": false, "description": "

The measurement units. The following values are supported:

\n", "schema": { "anyOf": [ { "type": "string", "enum": [ "imperial", "metric" ], "title": "MeasurementUnit" }, { "type": "null" } ], "description": "

The measurement units. The following values are supported:

\n", "title": "Units" }, "deprecated": false, "examples": { "Metric units": { "value": "metric" }, "Imperial units": { "value": "imperial" } } } ], "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:f6b4f4e5a432db282e423dec8d1e9e9368c56365c2a96b7ab0ae48b4fac506bf" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/any_brave_search_apis_v1_brave_local_pois" } }, "/apis/v1/brave/news/search": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "get_any_brave_search_apis_v1_brave_news_search", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_NewsSearchApiResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "News Search", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET", "POST" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "52ed4acdb714" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/news/search", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_news_search", "method": "ANY", "path": "/apis/v1/brave/news/search" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "count", "in": "query", "required": false, "description": "The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "default": 20, "title": "Count" }, "deprecated": false }, { "name": "country", "in": "query", "required": false, "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide.", "schema": { "allOf": [ { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, { "default": "US" } ], "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide." }, "deprecated": false }, { "name": "extra_snippets", "in": "query", "required": false, "description": "A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts.", "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts.", "title": "Extra Snippets" }, "deprecated": false, "examples": { "": { "value": "" }, "Include extra snippets": { "value": true }, "Exclude extra snippets": { "value": false } } }, { "name": "freshness", "in": "query", "required": false, "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "schema": { "type": "string", "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "examples": [ "", "pm", "2022-04-01to2022-07-30" ], "default": "", "title": "Freshness" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": "pm" }, "2": { "value": "2022-04-01to2022-07-30" } } }, { "name": "goggles", "in": "query", "required": false, "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles.", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles.", "title": "Goggles" }, "deprecated": false, "examples": { "": { "value": "" }, "Prioritizes domains popular with the Hacker News": { "value": "https://raw.githubusercontent.com/brave/goggles-quickstart/main/goggles/hacker_news.goggle" }, "Social media blocker": { "value": "! name: Social Networks\n! description: Removes social networks\n! public: true\n! author: Average Joe\n! avatar: #de0320\n$discard,site=facebook.com\n$discard,site=x.com\n$discard,site=instagram.com" } } }, { "name": "include_fetch_metadata", "in": "query", "required": false, "description": "Include fetch metadata.", "schema": { "type": "boolean", "description": "Include fetch metadata.", "examples": [ "", true, false ], "default": false, "title": "Include Fetch Metadata" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } } }, { "name": "offset", "in": "query", "required": false, "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "schema": { "type": "integer", "maximum": 9, "minimum": 0, "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "default": 0, "title": "Offset" }, "deprecated": false }, { "name": "operators", "in": "query", "required": false, "description": "Whether to apply search operators.", "schema": { "type": "boolean", "description": "Whether to apply search operators.", "examples": [ "", true, false ], "default": true, "title": "Operators" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } } }, { "name": "q", "in": "query", "required": true, "description": "The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "schema": { "type": "string", "minLength": 1, "maxLength": 400, "title": "The user's search query term.", "description": "The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query." }, "deprecated": false }, { "name": "safesearch", "in": "query", "required": false, "description": "

Filters search results for adult content. The following values are supported:

\n", "schema": { "allOf": [ { "type": "string", "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch" }, { "default": "strict" } ], "title": "Safe search", "description": "

Filters search results for adult content. The following values are supported:

\n", "examples": [ "", "off", "moderate", "strict" ] }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": "off" }, "2": { "value": "moderate" }, "3": { "value": "strict" } } }, { "name": "search_lang", "in": "query", "required": false, "description": "The search language preference. The 2 or more character language code for which the search results are provided.", "schema": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "description": "The search language preference. The 2 or more character language code for which the search results are provided." }, "deprecated": false }, { "name": "spellcheck", "in": "query", "required": false, "description": "Whether to spell check the provided query. If the spellchecker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "schema": { "type": "boolean", "description": "Whether to spell check the provided query. If the spellchecker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "examples": [ "", true, false ], "default": true, "title": "Spellcheck" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } } }, { "name": "ui_lang", "in": "query", "required": false, "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.", "schema": { "allOf": [ { "type": "string", "enum": [ "es-AR", "en-AU", "de-AT", "nl-BE", "fr-BE", "pt-BR", "en-CA", "fr-CA", "es-CL", "da-DK", "fi-FI", "fr-FR", "de-DE", "el-GR", "zh-HK", "en-IN", "en-ID", "it-IT", "ja-JP", "ko-KR", "en-MY", "es-MX", "nl-NL", "en-NZ", "no-NO", "zh-CN", "pl-PL", "en-PH", "ru-RU", "en-ZA", "es-ES", "sv-SE", "fr-CH", "de-CH", "zh-TW", "tr-TR", "en-GB", "en-US", "es-US" ], "title": "MarketCodes" }, { "default": "en-US" } ], "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110." }, "deprecated": false } ], "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:e20569675e6ace1ebde488b9229bea3c801882aa6525de89a71cbaf37b1a82f1" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/get_any_brave_search_apis_v1_brave_news_search" }, "post": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "post_any_brave_search_apis_v1_brave_news_search", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_NewsSearchApiResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "News Search", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET", "POST" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "52ed4acdb714" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/news/search", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_news_search", "method": "ANY", "path": "/apis/v1/brave/news/search" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } } ], "requestBody": { "required": true, "description": "", "content": { "application/json": { "schema": { "properties": { "q": { "type": "string", "maxLength": 400, "minLength": 1, "title": "The user's search query term.", "description": "The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query." }, "search_lang": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "description": "The search language preference. The 2 or more character language code for which the search results are provided." }, "ui_lang": { "allOf": [ { "type": "string", "enum": [ "es-AR", "en-AU", "de-AT", "nl-BE", "fr-BE", "pt-BR", "en-CA", "fr-CA", "es-CL", "da-DK", "fi-FI", "fr-FR", "de-DE", "el-GR", "zh-HK", "en-IN", "en-ID", "it-IT", "ja-JP", "ko-KR", "en-MY", "es-MX", "nl-NL", "en-NZ", "no-NO", "zh-CN", "pl-PL", "en-PH", "ru-RU", "en-ZA", "es-ES", "sv-SE", "fr-CH", "de-CH", "zh-TW", "tr-TR", "en-GB", "en-US", "es-US" ], "title": "MarketCodes" }, { "default": "en-US" } ], "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110." }, "country": { "allOf": [ { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, { "default": "US" } ], "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide." }, "safesearch": { "allOf": [ { "type": "string", "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch" }, { "default": "strict" } ], "title": "Safe search", "description": "

Filters search results for adult content. The following values are supported:

\n", "examples": [ "", "off", "moderate", "strict" ] }, "count": { "type": "integer", "maximum": 50, "minimum": 1, "title": "Count", "description": "The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "default": 20 }, "offset": { "type": "integer", "maximum": 9, "minimum": 0, "title": "Offset", "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "default": 0 }, "spellcheck": { "type": "boolean", "title": "Spellcheck", "description": "Whether to spell check the provided query. If the spellchecker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "default": true, "examples": [ "", true, false ] }, "freshness": { "type": "string", "title": "Freshness", "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "default": "", "examples": [ "", "pm", "2022-04-01to2022-07-30" ] }, "extra_snippets": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Extra Snippets", "description": "A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts." }, "goggles": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Goggles", "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles." }, "include_fetch_metadata": { "type": "boolean", "title": "Include Fetch Metadata", "description": "Include fetch metadata.", "default": false, "examples": [ "", true, false ] }, "operators": { "type": "boolean", "title": "Operators", "description": "Whether to apply search operators.", "default": true, "examples": [ "", true, false ] } }, "type": "object", "required": [ "q" ], "title": "NewsSearchParameters" } } } }, "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:e20569675e6ace1ebde488b9229bea3c801882aa6525de89a71cbaf37b1a82f1" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/post_any_brave_search_apis_v1_brave_news_search" } }, "/apis/v1/brave/spellcheck/search": { "get": { "description": "\nPublished reference price: $0.0005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "any_brave_search_apis_v1_brave_spellcheck_search", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SpellCheckSearchApiResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Spell Check", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.0005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "4ac0bd8c1c40" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/spellcheck/search", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_spellcheck_search", "method": "ANY", "path": "/apis/v1/brave/spellcheck/search" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "country", "in": "query", "required": false, "description": "The spell check country, where potentially the results could come from. The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating spellcheck responses.", "schema": { "allOf": [ { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, { "default": "US" } ], "description": "The spell check country, where potentially the results could come from. The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating spellcheck responses." }, "deprecated": false }, { "name": "lang", "in": "query", "required": false, "description": "The spell check language preference, where potentially the results could come from. The 2 or more character language code for which the spell check search results are provided. This is a just a hint for calculating spell check responses.", "schema": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "description": "The spell check language preference, where potentially the results could come from. The 2 or more character language code for which the spell check search results are provided. This is a just a hint for calculating spell check responses." }, "deprecated": false }, { "name": "q", "in": "query", "required": true, "description": "The phrase to be spell checked. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "schema": { "type": "string", "minLength": 1, "maxLength": 400, "description": "The phrase to be spell checked. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "title": "Q" }, "deprecated": false } ], "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:b4a41203bb6e54627b9d7797b8d31ae7fec699e9521e774c7d197a71eff7694c" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/any_brave_search_apis_v1_brave_spellcheck_search" } }, "/apis/v1/brave/suggest/search": { "get": { "description": "\nPublished reference price: $0.0005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "any_brave_search_apis_v1_brave_suggest_search", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_SuggestSearchApiResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Suggest", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.0005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "9307e8fb968b" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/suggest/search", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_suggest_search", "method": "ANY", "path": "/apis/v1/brave/suggest/search" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "count", "in": "query", "required": false, "description": "The number of suggestion search results returned in response. The actual number of results delivered may be less than requested. Minimum is 1, maximum is 20. The default is 5.", "schema": { "type": "integer", "maximum": 20, "minimum": 1, "description": "The number of suggestion search results returned in response. The actual number of results delivered may be less than requested. Minimum is 1, maximum is 20. The default is 5.", "default": 5, "title": "Count" }, "deprecated": false }, { "name": "country", "in": "query", "required": false, "description": "The suggest search query country, where potentially the results could come from. The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating suggest responses.", "schema": { "allOf": [ { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, { "default": "US" } ], "description": "The suggest search query country, where potentially the results could come from. The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating suggest responses." }, "deprecated": false }, { "name": "lang", "in": "query", "required": false, "description": "The suggest search language preference, where potentially the results could come from. The 2 or more character language code for which the suggest search results are provided. This is a just a hint for calculating suggest responses.", "schema": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "description": "The suggest search language preference, where potentially the results could come from. The 2 or more character language code for which the suggest search results are provided. This is a just a hint for calculating suggest responses." }, "deprecated": false }, { "name": "q", "in": "query", "required": true, "description": "The user’s suggest search query term. Query can not be empty. The max query length is 400 characters, and the word limit is 50 words.", "schema": { "type": "string", "minLength": 1, "maxLength": 400, "title": "The user's suggest search query term.", "description": "The user’s suggest search query term. Query can not be empty. The max query length is 400 characters, and the word limit is 50 words." }, "deprecated": false }, { "name": "rich", "in": "query", "required": false, "description": "Whether to enhance suggestions with rich results. This requires a paid autosuggest subscription.", "schema": { "type": "boolean", "description": "Whether to enhance suggestions with rich results. This requires a paid autosuggest subscription.", "default": false, "title": "Rich" }, "deprecated": false, "examples": { "Include rich suggestions": { "value": true }, "Exclude rich suggestions": { "value": false } } } ], "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:7a25aac0e9fe8281b9f50708b98583e293e6946872321df3035a50653e0d5872" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/any_brave_search_apis_v1_brave_suggest_search" } }, "/apis/v1/brave/videos/search": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "get_any_brave_search_apis_v1_brave_videos_search", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_VideoSearchApiResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Video Search", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET", "POST" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "237b2129991c" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/videos/search", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_videos_search", "method": "ANY", "path": "/apis/v1/brave/videos/search" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "count", "in": "query", "required": false, "description": "The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "default": 20, "title": "Count" }, "deprecated": false }, { "name": "country", "in": "query", "required": false, "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide.", "schema": { "allOf": [ { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, { "default": "US" } ], "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide." }, "deprecated": false }, { "name": "freshness", "in": "query", "required": false, "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "schema": { "type": "string", "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "examples": [ "", "pm", "2022-04-01to2022-07-30" ], "default": "", "title": "Freshness" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": "pm" }, "2": { "value": "2022-04-01to2022-07-30" } } }, { "name": "include_fetch_metadata", "in": "query", "required": false, "description": "Include fetch metadata.", "schema": { "type": "boolean", "description": "Include fetch metadata.", "examples": [ "", true, false ], "default": false, "title": "Include Fetch Metadata" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } } }, { "name": "offset", "in": "query", "required": false, "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "schema": { "type": "integer", "maximum": 9, "minimum": 0, "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "default": 0, "title": "Offset" }, "deprecated": false }, { "name": "operators", "in": "query", "required": false, "description": "Whether to apply search operators.", "schema": { "type": "boolean", "description": "Whether to apply search operators.", "examples": [ "", true, false ], "default": true, "title": "Operators" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } } }, { "name": "q", "in": "query", "required": true, "description": "The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "schema": { "type": "string", "minLength": 1, "maxLength": 400, "description": "The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "title": "Q" }, "deprecated": false }, { "name": "safesearch", "in": "query", "required": false, "description": "

Filters search results for adult content. The following values are supported:

\n", "schema": { "allOf": [ { "type": "string", "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch" }, { "default": "moderate" } ], "title": "Safe search", "description": "

Filters search results for adult content. The following values are supported:

\n", "examples": [ "", "off", "moderate", "strict" ] }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": "off" }, "2": { "value": "moderate" }, "3": { "value": "strict" } } }, { "name": "search_lang", "in": "query", "required": false, "description": "The search language preference. The 2 or more character language code for which the search results are provided.", "schema": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "description": "The search language preference. The 2 or more character language code for which the search results are provided." }, "deprecated": false }, { "name": "spellcheck", "in": "query", "required": false, "description": "Whether to spell check the provided query. If the spellchecker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "schema": { "type": "boolean", "description": "Whether to spell check the provided query. If the spellchecker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "examples": [ "", true, false ], "default": true, "title": "Spellcheck" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } } }, { "name": "ui_lang", "in": "query", "required": false, "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.", "schema": { "allOf": [ { "type": "string", "enum": [ "es-AR", "en-AU", "de-AT", "nl-BE", "fr-BE", "pt-BR", "en-CA", "fr-CA", "es-CL", "da-DK", "fi-FI", "fr-FR", "de-DE", "el-GR", "zh-HK", "en-IN", "en-ID", "it-IT", "ja-JP", "ko-KR", "en-MY", "es-MX", "nl-NL", "en-NZ", "no-NO", "zh-CN", "pl-PL", "en-PH", "ru-RU", "en-ZA", "es-ES", "sv-SE", "fr-CH", "de-CH", "zh-TW", "tr-TR", "en-GB", "en-US", "es-US" ], "title": "MarketCodes" }, { "default": "en-US" } ], "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110." }, "deprecated": false } ], "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:1b66fdcaa1486eaad979c18a159bb8b81df608bac15a6918e1e7178f420f1a81" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/get_any_brave_search_apis_v1_brave_videos_search" }, "post": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "post_any_brave_search_apis_v1_brave_videos_search", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_VideoSearchApiResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Video Search", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET", "POST" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "237b2129991c" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/videos/search", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_videos_search", "method": "ANY", "path": "/apis/v1/brave/videos/search" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } } ], "requestBody": { "required": true, "description": "", "content": { "application/json": { "schema": { "properties": { "q": { "type": "string", "maxLength": 400, "minLength": 1, "title": "Q", "description": "The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query." }, "search_lang": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "description": "The search language preference. The 2 or more character language code for which the search results are provided." }, "ui_lang": { "allOf": [ { "type": "string", "enum": [ "es-AR", "en-AU", "de-AT", "nl-BE", "fr-BE", "pt-BR", "en-CA", "fr-CA", "es-CL", "da-DK", "fi-FI", "fr-FR", "de-DE", "el-GR", "zh-HK", "en-IN", "en-ID", "it-IT", "ja-JP", "ko-KR", "en-MY", "es-MX", "nl-NL", "en-NZ", "no-NO", "zh-CN", "pl-PL", "en-PH", "ru-RU", "en-ZA", "es-ES", "sv-SE", "fr-CH", "de-CH", "zh-TW", "tr-TR", "en-GB", "en-US", "es-US" ], "title": "MarketCodes" }, { "default": "en-US" } ], "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110." }, "country": { "allOf": [ { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, { "default": "US" } ], "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide." }, "safesearch": { "allOf": [ { "type": "string", "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch" }, { "default": "moderate" } ], "title": "Safe search", "description": "

Filters search results for adult content. The following values are supported:

\n", "examples": [ "", "off", "moderate", "strict" ] }, "count": { "type": "integer", "maximum": 50, "minimum": 1, "title": "Count", "description": "The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "default": 20 }, "offset": { "type": "integer", "maximum": 9, "minimum": 0, "title": "Offset", "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "default": 0 }, "spellcheck": { "type": "boolean", "title": "Spellcheck", "description": "Whether to spell check the provided query. If the spellchecker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "default": true, "examples": [ "", true, false ] }, "freshness": { "type": "string", "title": "Freshness", "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "default": "", "examples": [ "", "pm", "2022-04-01to2022-07-30" ] }, "include_fetch_metadata": { "type": "boolean", "title": "Include Fetch Metadata", "description": "Include fetch metadata.", "default": false, "examples": [ "", true, false ] }, "operators": { "type": "boolean", "title": "Operators", "description": "Whether to apply search operators.", "default": true, "examples": [ "", true, false ] } }, "type": "object", "required": [ "q" ], "title": "VideoSearchParameters" } } } }, "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:1b66fdcaa1486eaad979c18a159bb8b81df608bac15a6918e1e7178f420f1a81" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/post_any_brave_search_apis_v1_brave_videos_search" } }, "/apis/v1/brave/web/rich": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "any_brave_search_apis_v1_brave_web_rich", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_RichHeaderResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Rich Search", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "3cd4d82206d1" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/web/rich", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_web_rich", "method": "ANY", "path": "/apis/v1/brave/web/rich" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "callback_key", "in": "query", "required": true, "description": "The callback key to use for the rich header", "schema": { "type": "string", "description": "The callback key to use for the rich header", "title": "Callback Key" }, "deprecated": false } ], "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:2f5cacc9d2b4a16e763318f162d714626580d34a4505d0cb4c716e152c9e9a79" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/any_brave_search_apis_v1_brave_web_rich" } }, "/apis/v1/brave/web/search": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "get_any_brave_search_apis_v1_brave_web_search", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_WebSearchApiResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Web Search", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET", "POST" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "9f88e4015f2b" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/web/search", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_web_search", "method": "ANY", "path": "/apis/v1/brave/web/search" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "x-loc-city", "in": "header", "required": false, "description": "The generic name of the client city.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "The generic name of the client city." }, "deprecated": false, "examples": { "City in USA": { "value": "San Francisco" } } }, { "name": "x-loc-country", "in": "header", "required": false, "description": "

The two letter country code for the client’s country.\nFor a list of country codes, see ISO 3166-1 alpha-2.

", "schema": { "anyOf": [ { "type": "string", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "Country" }, { "type": "null" } ], "title": "Country code", "description": "

The two letter country code for the client’s country.\nFor a list of country codes, see ISO 3166-1 alpha-2.

", "examples": [ "US" ] }, "deprecated": false, "examples": { "0": { "value": "US" } } }, { "name": "x-loc-lat", "in": "header", "required": false, "description": "The latitude of the client’s geographical location in degrees, to provide relevant local results. The latitude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees.", "schema": { "anyOf": [ { "type": "number", "maximum": 90, "minimum": -90 }, { "type": "null" } ], "title": "Latitude", "description": "The latitude of the client’s geographical location in degrees, to provide relevant local results. The latitude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees.", "examples": [ 37.787 ] }, "deprecated": false, "examples": { "0": { "value": 37.787 } } }, { "name": "x-loc-long", "in": "header", "required": false, "description": "The longitude of the client’s geographical location in degrees, to provide relevant local results. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0 degrees.", "schema": { "anyOf": [ { "type": "number", "maximum": 180, "minimum": -180 }, { "type": "null" } ], "title": "Longitude", "description": "The longitude of the client’s geographical location in degrees, to provide relevant local results. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0 degrees.", "examples": [ -122.4 ] }, "deprecated": false, "examples": { "0": { "value": -122.4 } } }, { "name": "x-loc-postal-code", "in": "header", "required": false, "description": "The client’s postal code.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal code", "description": "The client’s postal code." }, "deprecated": false, "examples": { "Postal code in San Francisco, California, US": { "value": "94105" } } }, { "name": "x-loc-state", "in": "header", "required": false, "description": "A code which could be up to three characters, that represent the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State/Region code", "description": "A code which could be up to three characters, that represent the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "examples": [ "CA" ] }, "deprecated": false, "examples": { "0": { "value": "CA" } } }, { "name": "x-loc-state-name", "in": "header", "required": false, "description": "The name of the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State/Region name", "description": "The name of the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "examples": [ "California" ] }, "deprecated": false, "examples": { "0": { "value": "California" } } }, { "name": "x-loc-timezone", "in": "header", "required": false, "description": "The IANA timezone for the client’s device. For complete list of IANA timezones and location mappings see IANA Database and Geonames Database.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "IANA timezone", "description": "The IANA timezone for the client’s device. For complete list of IANA timezones and location mappings see IANA Database and Geonames Database." }, "deprecated": false, "examples": { "IANA timezone for San Francisco in USA": { "value": "America/San_Francisco" } } }, { "name": "count", "in": "query", "required": false, "description": "

The number of search results returned in response.\nThe maximum is 20. The actual number delivered may be less than requested.\nCombine this parameter with offset to paginate search results.

\n

NOTE: Count only applies to web results.

", "schema": { "type": "integer", "maximum": 20, "minimum": 1, "title": "Count", "description": "

The number of search results returned in response.\nThe maximum is 20. The actual number delivered may be less than requested.\nCombine this parameter with offset to paginate search results.

\n

NOTE: Count only applies to web results.

", "default": 20 }, "deprecated": false }, { "name": "country", "in": "query", "required": false, "description": "The 2 character country code where the search results come from.", "schema": { "allOf": [ { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, { "default": "US" } ], "title": "Search country", "description": "The 2 character country code where the search results come from." }, "deprecated": false }, { "name": "enable_rich_callback", "in": "query", "required": false, "description": "

Enable rich callback.\nAllows you to get real time rich results via a callback URL when they are relevant to your query.

\n

NOTE: Requires Search plan.

", "schema": { "type": "boolean", "description": "

Enable rich callback.\nAllows you to get real time rich results via a callback URL when they are relevant to your query.

\n

NOTE: Requires Search plan.

", "examples": [ "", false, true ], "default": false, "title": "Enable Rich Callback" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": false }, "2": { "value": true } } }, { "name": "extra_snippets", "in": "query", "required": false, "description": "A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts.", "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Extra snippets", "description": "A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts.", "examples": [ "", true, false ] }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } } }, { "name": "freshness", "in": "query", "required": false, "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "schema": { "type": "string", "title": "Freshness", "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "examples": [ "", "pm", "2022-04-01to2022-07-30" ], "default": "" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": "pm" }, "2": { "value": "2022-04-01to2022-07-30" } } }, { "name": "goggles", "in": "query", "required": false, "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles.", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Goggles", "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles." }, "deprecated": false, "examples": { "": { "value": "" }, "Prioritizes domains popular with the Hacker News": { "value": "https://raw.githubusercontent.com/brave/goggles-quickstart/main/goggles/hacker_news.goggle" }, "Social media blocker": { "value": "! name: Social Networks\n! description: Removes social networks\n! public: true\n! author: Average Joe\n! avatar: #de0320\n\n$discard,site=facebook.com\n$discard,site=x.com\n$discard,site=instagram.com" } } }, { "name": "goggles_id", "in": "query", "required": false, "description": "Goggles act as a custom re-ranking on top of Brave’s search index. For more details, refer to the Goggles repository. This parameter is deprecated. Please use the goggles parameter.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Goggles id", "description": "Goggles act as a custom re-ranking on top of Brave’s search index. For more details, refer to the Goggles repository. This parameter is deprecated. Please use the goggles parameter." }, "deprecated": true, "examples": { "": { "value": "" }, "Prioritizes domains popular with the Hacker News": { "value": "https://raw.githubusercontent.com/brave/goggles-quickstart/main/goggles/hacker_news.goggle" } } }, { "name": "include_fetch_metadata", "in": "query", "required": false, "description": "Include fetch metadata.", "schema": { "type": "boolean", "description": "Include fetch metadata.", "examples": [ "", false, true ], "default": false, "title": "Include Fetch Metadata" }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": false }, "2": { "value": true } } }, { "name": "offset", "in": "query", "required": false, "description": "

The zero based offset that indicates number of search\nresult pages (count) to skip before returning the result.\nThe default is 0 and the maximum is 9.\nThe actual number delivered may be less than requested.

\n

Use this parameter along with the count parameter to page results.\nFor example, if your user interface displays 10 search results per page,\nset count to 10 and offset to 0 to get the first page of results.\nFor each subsequent page, increment offset by 1 (for example, 0, 1, 2).\nIt is possible for multiple pages to include some overlap in results.

", "schema": { "type": "integer", "maximum": 9, "minimum": 0, "title": "Offset", "description": "

The zero based offset that indicates number of search\nresult pages (count) to skip before returning the result.\nThe default is 0 and the maximum is 9.\nThe actual number delivered may be less than requested.

\n

Use this parameter along with the count parameter to page results.\nFor example, if your user interface displays 10 search results per page,\nset count to 10 and offset to 0 to get the first page of results.\nFor each subsequent page, increment offset by 1 (for example, 0, 1, 2).\nIt is possible for multiple pages to include some overlap in results.

", "default": 0 }, "deprecated": false }, { "name": "operators", "in": "query", "required": false, "description": "Whether to apply search operators", "schema": { "type": "boolean", "title": "Operators", "description": "Whether to apply search operators", "examples": [ "", true, false ], "default": true }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } } }, { "name": "q", "in": "query", "required": true, "description": "The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query.", "schema": { "type": "string", "minLength": 1, "maxLength": 600, "title": "Query", "description": "The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query." }, "deprecated": false, "examples": { "default": { "value": "brave search" } } }, { "name": "result_filter", "in": "query", "required": false, "description": "

A comma delimited string of result types to include in the search response.\nNot specifying this parameter will return back all result types in search response where data is available\nand the plan has the corresponding option activated. The response always includes query and type to\nidentify any query modifications and response type respectively.\nAvailable result filter values are: discussions, faq, infobox, news, query, summarizer, videos, web, locations.

\n

NOTE: count param only applies to web results.

", "schema": { "anyOf": [ { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, { "type": "null" } ], "title": "Result filter", "description": "

A comma delimited string of result types to include in the search response.\nNot specifying this parameter will return back all result types in search response where data is available\nand the plan has the corresponding option activated. The response always includes query and type to\nidentify any query modifications and response type respectively.\nAvailable result filter values are: discussions, faq, infobox, news, query, summarizer, videos, web, locations.

\n

NOTE: count param only applies to web results.

", "examples": [ "", "web", "videos", "web,videos" ] }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": "web" }, "2": { "value": "videos" }, "3": { "value": "web,videos" } } }, { "name": "safesearch", "in": "query", "required": false, "description": "

Filters search results for adult content. The following values are supported:

\n", "schema": { "allOf": [ { "type": "string", "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch" }, { "default": "moderate" } ], "title": "Safe search", "description": "

Filters search results for adult content. The following values are supported:

\n", "examples": [ "", "off", "moderate", "strict" ] }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": "off" }, "2": { "value": "moderate" }, "3": { "value": "strict" } } }, { "name": "search_lang", "in": "query", "required": false, "description": "The 2 or more character language code for which the search results are provided.", "schema": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "title": "Search language", "description": "The 2 or more character language code for which the search results are provided." }, "deprecated": false }, { "name": "spellcheck", "in": "query", "required": false, "description": "Whether to spell check provided query. If the spell checker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "schema": { "type": "boolean", "title": "Spellcheck", "description": "Whether to spell check provided query. If the spell checker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "examples": [ "", true, false ], "default": true }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } } }, { "name": "summary", "in": "query", "required": false, "description": "This parameter enables summary key generation in web search results. This is required for summarizer to be enabled.", "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Summary", "description": "This parameter enables summary key generation in web search results. This is required for summarizer to be enabled.", "examples": [ "", true, false ] }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } } }, { "name": "text_decorations", "in": "query", "required": false, "description": "Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters).", "schema": { "type": "boolean", "title": "Text decorations", "description": "Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters).", "examples": [ "", true, false ], "default": true }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } } }, { "name": "ui_lang", "in": "query", "required": false, "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.", "schema": { "allOf": [ { "type": "string", "enum": [ "es-AR", "en-AU", "de-AT", "nl-BE", "fr-BE", "pt-BR", "en-CA", "fr-CA", "es-CL", "da-DK", "fi-FI", "fr-FR", "de-DE", "el-GR", "zh-HK", "en-IN", "en-ID", "it-IT", "ja-JP", "ko-KR", "en-MY", "es-MX", "nl-NL", "en-NZ", "no-NO", "zh-CN", "pl-PL", "en-PH", "ru-RU", "en-ZA", "es-ES", "sv-SE", "fr-CH", "de-CH", "zh-TW", "tr-TR", "en-GB", "en-US", "es-US" ], "title": "MarketCodes" }, { "default": "en-US" } ], "title": "User interface language", "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110." }, "deprecated": false }, { "name": "units", "in": "query", "required": false, "description": "

The measurement units. The following values are supported:

\n", "schema": { "anyOf": [ { "type": "string", "enum": [ "imperial", "metric" ], "title": "MeasurementUnit" }, { "type": "null" } ], "title": "Units", "description": "

The measurement units. The following values are supported:

\n", "examples": [ "", "metric", "imperial" ] }, "deprecated": false, "examples": { "0": { "value": "" }, "1": { "value": "metric" }, "2": { "value": "imperial" } } } ], "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:2619967ce3508da2b902ca829a9a057100e18257ddf3079be5ef1660664d6734" }, "x-codeSamples": [ { "lang": "text", "label": "Reference example", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/brave/web/search?q=brave+search' \\\n --header 'Authorization: Bearer '" } ], "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/get_any_brave_search_apis_v1_brave_web_search" }, "post": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "post_any_brave_search_apis_v1_brave_web_search", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseB91D37C29Ffe_WebSearchApiResponse" } } } }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Web Search", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "mpp": true, "mpp_methods": [ "GET", "POST" ], "x402": false }, "x-aisa-category": "13", "x-aisa-passthrough": true, "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": true }, "x-aisa-revision": { "customer_pricing_ref": "5a1e4970a8aa", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "9f88e4015f2b" }, "x-aisa-status": "enabled", "x-aisa-upstream-path": "/res/v1/web/search", "x-aisa-validation": "provider", "x-aisa-catalog-id": "brave-search", "x-aisa-runtime-operation": { "operation_id": "any_brave_search_apis_v1_brave_web_search", "method": "ANY", "path": "/apis/v1/brave/web/search" }, "parameters": [ { "name": "accept", "in": "header", "required": false, "description": "The default supported media type is application/json.", "schema": { "allOf": [ { "type": "string", "enum": [ "application/json", "*/*" ], "title": "Accept" }, { "default": "application/json" } ], "title": "Media type", "description": "The default supported media type is application/json.", "examples": [ "application/json" ] }, "deprecated": false, "examples": { "0": { "value": "application/json" } } }, { "name": "api-version", "in": "header", "required": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "API version", "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning." }, "deprecated": false }, { "name": "cache-control", "in": "header", "required": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "schema": { "anyOf": [ { "type": "string", "enum": [ "no-cache" ], "const": "no-cache", "title": "CacheControl" }, { "type": "null" } ], "title": "Cache control", "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort." }, "deprecated": false }, { "name": "user-agent", "in": "header", "required": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User agent", "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110." }, "deprecated": false, "examples": { "Android": { "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36", "description": "Android" }, "iOS": { "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1", "description": "iOS" }, "macOS": { "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "macOS" }, "Windows": { "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "description": "Windows" } } }, { "name": "x-loc-city", "in": "header", "required": false, "description": "The generic name of the client city.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "The generic name of the client city." }, "deprecated": false, "examples": { "City in USA": { "value": "San Francisco" } } }, { "name": "x-loc-country", "in": "header", "required": false, "description": "

The two letter country code for the client’s country.\nFor a list of country codes, see ISO 3166-1 alpha-2.

", "schema": { "anyOf": [ { "type": "string", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "Country" }, { "type": "null" } ], "title": "Country code", "description": "

The two letter country code for the client’s country.\nFor a list of country codes, see ISO 3166-1 alpha-2.

", "examples": [ "US" ] }, "deprecated": false, "examples": { "0": { "value": "US" } } }, { "name": "x-loc-lat", "in": "header", "required": false, "description": "The latitude of the client’s geographical location in degrees, to provide relevant local results. The latitude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees.", "schema": { "anyOf": [ { "type": "number", "maximum": 90, "minimum": -90 }, { "type": "null" } ], "title": "Latitude", "description": "The latitude of the client’s geographical location in degrees, to provide relevant local results. The latitude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees.", "examples": [ 37.787 ] }, "deprecated": false, "examples": { "0": { "value": 37.787 } } }, { "name": "x-loc-long", "in": "header", "required": false, "description": "The longitude of the client’s geographical location in degrees, to provide relevant local results. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0 degrees.", "schema": { "anyOf": [ { "type": "number", "maximum": 180, "minimum": -180 }, { "type": "null" } ], "title": "Longitude", "description": "The longitude of the client’s geographical location in degrees, to provide relevant local results. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0 degrees.", "examples": [ -122.4 ] }, "deprecated": false, "examples": { "0": { "value": -122.4 } } }, { "name": "x-loc-postal-code", "in": "header", "required": false, "description": "The client’s postal code.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal code", "description": "The client’s postal code." }, "deprecated": false, "examples": { "Postal code in San Francisco, California, US": { "value": "94105" } } }, { "name": "x-loc-state", "in": "header", "required": false, "description": "A code which could be up to three characters, that represent the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State/Region code", "description": "A code which could be up to three characters, that represent the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "examples": [ "CA" ] }, "deprecated": false, "examples": { "0": { "value": "CA" } } }, { "name": "x-loc-state-name", "in": "header", "required": false, "description": "The name of the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State/Region name", "description": "The name of the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "examples": [ "California" ] }, "deprecated": false, "examples": { "0": { "value": "California" } } }, { "name": "x-loc-timezone", "in": "header", "required": false, "description": "The IANA timezone for the client’s device. For complete list of IANA timezones and location mappings see IANA Database and Geonames Database.", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "IANA timezone", "description": "The IANA timezone for the client’s device. For complete list of IANA timezones and location mappings see IANA Database and Geonames Database." }, "deprecated": false, "examples": { "IANA timezone for San Francisco in USA": { "value": "America/San_Francisco" } } } ], "requestBody": { "required": true, "description": "", "content": { "application/json": { "schema": { "properties": { "q": { "type": "string", "maxLength": 600, "minLength": 1, "title": "Query", "description": "The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query." }, "country": { "allOf": [ { "type": "string", "enum": [ "AR", "AU", "AT", "BE", "BR", "CA", "CL", "DK", "FI", "FR", "DE", "GR", "HK", "IN", "ID", "IT", "JP", "KR", "MY", "MX", "NL", "NZ", "NO", "CN", "PL", "PT", "PH", "RU", "SA", "ZA", "ES", "SE", "CH", "TW", "TR", "GB", "US", "ALL" ], "title": "SearchCountry" }, { "default": "US" } ], "title": "Search country", "description": "The 2 character country code where the search results come from." }, "search_lang": { "allOf": [ { "type": "string", "enum": [ "ar", "eu", "bn", "bg", "ca", "zh-hans", "zh-hant", "hr", "cs", "da", "nl", "en", "en-gb", "et", "fi", "fr", "gl", "de", "el", "gu", "he", "hi", "hu", "is", "it", "ja", "jp", "kn", "ko", "lv", "lt", "ms", "ml", "mr", "nb", "pl", "pt-br", "pt-pt", "pa", "ro", "ru", "sr", "sk", "sl", "es", "sv", "ta", "te", "th", "tr", "uk", "vi" ], "title": "Language" }, { "default": "en" } ], "title": "Search language", "description": "The 2 or more character language code for which the search results are provided." }, "ui_lang": { "allOf": [ { "type": "string", "enum": [ "es-AR", "en-AU", "de-AT", "nl-BE", "fr-BE", "pt-BR", "en-CA", "fr-CA", "es-CL", "da-DK", "fi-FI", "fr-FR", "de-DE", "el-GR", "zh-HK", "en-IN", "en-ID", "it-IT", "ja-JP", "ko-KR", "en-MY", "es-MX", "nl-NL", "en-NZ", "no-NO", "zh-CN", "pl-PL", "en-PH", "ru-RU", "en-ZA", "es-ES", "sv-SE", "fr-CH", "de-CH", "zh-TW", "tr-TR", "en-GB", "en-US", "es-US" ], "title": "MarketCodes" }, { "default": "en-US" } ], "title": "User interface language", "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110." }, "count": { "type": "integer", "maximum": 20, "minimum": 1, "title": "Count", "description": "

The number of search results returned in response.\nThe maximum is 20. The actual number delivered may be less than requested.\nCombine this parameter with offset to paginate search results.

\n

NOTE: Count only applies to web results.

", "default": 20 }, "offset": { "type": "integer", "maximum": 9, "minimum": 0, "title": "Offset", "description": "

The zero based offset that indicates number of search\nresult pages (count) to skip before returning the result.\nThe default is 0 and the maximum is 9.\nThe actual number delivered may be less than requested.

\n

Use this parameter along with the count parameter to page results.\nFor example, if your user interface displays 10 search results per page,\nset count to 10 and offset to 0 to get the first page of results.\nFor each subsequent page, increment offset by 1 (for example, 0, 1, 2).\nIt is possible for multiple pages to include some overlap in results.

", "default": 0 }, "safesearch": { "allOf": [ { "type": "string", "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch" }, { "default": "moderate" } ], "title": "Safe search", "description": "

Filters search results for adult content. The following values are supported:

\n", "examples": [ "", "off", "moderate", "strict" ] }, "spellcheck": { "type": "boolean", "title": "Spellcheck", "description": "Whether to spell check provided query. If the spell checker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "default": true, "examples": [ "", true, false ] }, "freshness": { "type": "string", "title": "Freshness", "description": "

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

\n", "default": "", "examples": [ "", "pm", "2022-04-01to2022-07-30" ] }, "text_decorations": { "type": "boolean", "title": "Text decorations", "description": "Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters).", "default": true, "examples": [ "", true, false ] }, "result_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Result filter", "description": "

A comma delimited string of result types to include in the search response.\nNot specifying this parameter will return back all result types in search response where data is available\nand the plan has the corresponding option activated. The response always includes query and type to\nidentify any query modifications and response type respectively.\nAvailable result filter values are: discussions, faq, infobox, news, query, summarizer, videos, web, locations.

\n

NOTE: count param only applies to web results.

", "examples": [ "", "web", "videos", "web,videos" ] }, "units": { "anyOf": [ { "type": "string", "enum": [ "imperial", "metric" ], "title": "MeasurementUnit" }, { "type": "null" } ], "title": "Units", "description": "

The measurement units. The following values are supported:

\n", "examples": [ "", "metric", "imperial" ] }, "goggles_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Goggles id", "description": "Goggles act as a custom re-ranking on top of Brave’s search index. For more details, refer to the Goggles repository. This parameter is deprecated. Please use the goggles parameter.", "deprecated": true }, "goggles": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Goggles", "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles." }, "extra_snippets": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Extra snippets", "description": "A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts.", "examples": [ "", true, false ] }, "summary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Summary", "description": "This parameter enables summary key generation in web search results. This is required for summarizer to be enabled.", "examples": [ "", true, false ] }, "enable_rich_callback": { "type": "boolean", "title": "Enable Rich Callback", "description": "

Enable rich callback.\nAllows you to get real time rich results via a callback URL when they are relevant to your query.

\n

NOTE: Requires Search plan.

", "default": false, "examples": [ "", false, true ] }, "include_fetch_metadata": { "type": "boolean", "title": "Include Fetch Metadata", "description": "Include fetch metadata.", "default": false, "examples": [ "", false, true ] }, "operators": { "type": "boolean", "title": "Operators", "description": "Whether to apply search operators", "default": true, "examples": [ "", true, false ] } }, "type": "object", "required": [ "q" ], "title": "WebSearchParameters" } } } }, "x-aisa-source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "x-aisa-response-source": { "kind": "upstream_success_contract", "source": { "kind": "provider_openapi", "url": "https://api-dashboard.search.brave.com/llms.txt", "fetched_at": "2026-10-11T18:42:51.856482+00:00", "content_hash": "sha256:822bc102529a84d36bb9effe2f1d9e4f0af866efef79bc67914cc2501edd8626", "converter": "scripts/import_brave_reference.py@3", "source_pages": [ { "url": "https://api-dashboard.search.brave.com/api-reference/ai/answers/__data.json", "content_hash": "sha256:52c109c10f836716e93dda8933134f98f045caf8c78e8cf0ce63a1fc0b754c4f" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/get/__data.json", "content_hash": "sha256:3b02fc8c617b493d74da1b98337c57e2c34101ce1a6f87add3b5c0f5faf525d8" }, { "url": "https://api-dashboard.search.brave.com/api-reference/ai/llm_context/post/__data.json", "content_hash": "sha256:35820dbc01fe3a57e7020d508a2fadf49fbec3e6ff3363ef7500959d093f55a5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/images/image_search/__data.json", "content_hash": "sha256:ab4bc9c2042bb31c13bdc06d423c909ccde12916069f6ef1b069228f01db2a8d" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/get/__data.json", "content_hash": "sha256:3b1afa4e3f81f264d3f245b77ea5273d9a213d2b3de4b4d7dedc01894b37fc64" }, { "url": "https://api-dashboard.search.brave.com/api-reference/news/news_search/post/__data.json", "content_hash": "sha256:54e73cc6097e7df880dc42143933d9bc07f919e07b116625408bb032ef7d4cc5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/spell_check/__data.json", "content_hash": "sha256:85cd7a6d3f01850436d332cfc44a726210657f139c0cc80a47a9c74470766a9c" }, { "url": "https://api-dashboard.search.brave.com/api-reference/other/suggestions/__data.json", "content_hash": "sha256:5c4dbb20ea770ef2c97ba1c6c3775716bcd7d74d4d9bd87bd91e78116e6c769e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/get/__data.json", "content_hash": "sha256:ff221fa765497085ae7a4ce9752831b80c69af59990847057784ba50a68e405a" }, { "url": "https://api-dashboard.search.brave.com/api-reference/videos/video_search/post/__data.json", "content_hash": "sha256:f5b0f5a02fcdc52cff7f1618beebced3e0341afbf4b31a2ae18b92f61d51ecec" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/local_pois/__data.json", "content_hash": "sha256:1a3811afefd39e19506a0a24e3b463307f219cc7c08db9348cab8807a70909fe" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/place_search/__data.json", "content_hash": "sha256:389dee2acae3b6fb0fb516e7c7ec271a354fb511a616f68522d593c73109a87e" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/poi_descriptions/__data.json", "content_hash": "sha256:36d19685c3e9eb3a56b87f269648129524fb6f629418ea799889a142af516f47" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/rich_search/__data.json", "content_hash": "sha256:dd2d3f02606cdf073906b9a6d5c5bfcce1fb568092c56fa56742b378a55657e5" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/get/__data.json", "content_hash": "sha256:a001dfd07208f89cfcc9a34d90e4593cedc341320c669b270612086245561264" }, { "url": "https://api-dashboard.search.brave.com/api-reference/web/search/post/__data.json", "content_hash": "sha256:7c3c02d2a0a8cdc07d8ac787f96bcf949c684129c461f73a87374054794ab1f9" } ], "source_index_hash": "sha256:52c0cb183f49315a5ea590ab37a9fa11b5ba8ff14c7fd04609069c5553001997", "structured_source_hash": "sha256:3e120458b72eb3a3113d649793eccf719d67bca20a08745f6a5d92ea80159253", "owner": "AIsa-team/docs", "refresh_policy": "automatic", "review_period_days": 30, "refresh_interval_hours": 24, "policy_revision": "sha256:a28127338b1a641229c3afbb4225985e91539e9f038343db46915bbd72d1bb84" }, "content_hash": "sha256:2619967ce3508da2b902ca829a9a057100e18257ddf3079be5ef1660664d6734" }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/brave-search/post_any_brave_search_apis_v1_brave_web_search" } } } }