typesearch

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['query'], 'properties': {'days': {'type': 'integer', 'maximum': 365, 'minimum': 1, 'description': 'Only the last N days, 1 to 365. By default it depends on the chart: 30 for coverage, 7 for figures.'}, 'type': {'enum': ['auto', 'line', 'area', 'bar', 'bar_horizontal', 'stacked_bar', 'pie', 'donut', 'scatter', 'funnel', 'timeline', 'kpi', 'table'], 'type': 'string', 'default': 'auto', 'description': 'auto (default) picks the chart that tells the data best. Or force one: line, area, bar, bar_horizontal, stacked_bar, pie, donut, scatter, funnel, timeline, kpi, table.'}, 'index': {'type': 'string', 'pattern': '^idx_[a-z0-9]{6,40}$', 'description': 'Optional: chart your own custom index (idx_…) instead of the news: prices, ratings, availability, brands.'}, 'query': {'type': 'string', 'maxLength': 200, 'minLength': 2, 'description': 'What to chart, in plain words and any language: "blue dollar this week", "Milei vs Bullrich coverage", "tone of the IMF coverage", "which outlets cover lithium", or "prices" with index.'}, 'theme': {'enum': ['light', 'dark', 'editorial', 'electric'], 'type': 'string', 'default': 'light', 'description': 'light (default), dark, editorial (warm paper) or electric (deep blue).'}, 'compare': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80}, 'maxItems': 5, 'minItems': 2, 'description': 'What to compare, 2 to 5, if the query does not say it with "vs": ["Milei", "Bullrich"].'}, 'countries': {'type': 'array', 'items': {'type': 'string', 'maxLength': 20}, 'maxItems': 50, 'minItems': 1, 'description': 'Only sources from these countries: ISO 3166-1 alpha-2 codes, such as ["AR"] or ["US", "GB"].'}, 'languages': {'type': 'array', 'items': {'type': 'string', 'maxLength': 35}, 'maxItems': 20, 'minItems': 1, 'description': 'Only sources that publish in these languages: ISO 639-1 codes, such as ["es"] or ["en", "pt"].'}, 'interpretation': {'type': 'string', 'maxLength': 160, 'description': 'Optional: one of the `alternatives` of a previous call, to chart that reading of the query instead.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['type', 'title', 'cost_usd', 'request_id'], 'properties': {'id': {'type': 'string'}, 'data': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'points'], 'properties': {'name': {'type': 'string'}, 'points': {'type': 'array', 'items': {'type': 'object', 'required': ['x', 'y'], 'properties': {'x': {'type': ['string', 'number']}, 'y': {'type': 'number'}}, 'additionalProperties': False}}}, 'additionalProperties': False}, 'description': 'The values drawn (up to 40 per series).'}, 'rung': {'type': 'string', 'description': 'exact (the data asked for), partial (a verified part), related, coverage or stories (the closest thing found).'}, 'type': {'type': 'string'}, 'table': {'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {'type': ['string', 'number', 'null']}}, 'description': 'The rows of a table chart (up to 10), keyed by column label.'}, 'title': {'type': 'string', 'description': 'It states the finding.'}, 'cached': {'type': 'boolean', 'const': True}, 'events': {'type': 'array', 'items': {'type': 'object', 'required': ['date', 'label'], 'properties': {'date': {'type': 'string'}, 'label': {'type': 'string'}}, 'additionalProperties': False}}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['title', 'url'], 'properties': {'url': {'type': 'string'}, 'title': {'type': 'string'}, 'source': {'type': 'string'}}, 'additionalProperties': False}}, 'cost_usd': {'type': 'number'}, 'subtitle': {'type': 'string'}, 'warnings': {'type': 'array', 'items': {'type': 'object', 'required': ['code', 'message'], 'properties': {'code': {'type': 'string'}, 'message': {'type': 'string'}}, 'additionalProperties': False}}, 'embed_url': {'type': 'string', 'description': 'An iframe for a web page or app.'}, 'image_url': {'type': 'string', 'description': 'PNG: show it to the user.'}, 'improving': {'type': 'boolean', 'const': True, 'description': 'Still looking for the exact data: the image and embed update themselves if it arrives.'}, 'request_id': {'type': 'string'}, 'understood': {'type': 'string', 'description': 'What we understood the user expects to see.'}, 'key_figures': {'type': 'array', 'items': {'type': 'object', 'required': ['label', 'value'], 'properties': {'label': {'type': 'string'}, 'value': {'type': 'number'}, 'change': {'type': 'number'}, 'change_is_percent': {'type': 'boolean'}}, 'additionalProperties': False}}, 'alternatives': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Other readings of the query: pass one as `interpretation` to chart it instead.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['url'], 'properties': {'url': {'type': 'string', 'maxLength': 2000, 'description': 'The article URL whose story to find elsewhere.'}, 'days': {'type': 'integer', 'maximum': 365, 'minimum': 1, 'description': 'Only the last N days, 1 to 365. Defaults to 7.'}, 'max_results': {'type': 'integer', 'default': 10, 'maximum': 25, 'minimum': 1, 'description': 'How many results, 1 to 25. Defaults to 10.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['mode', 'results', 'cost_usd', 'request_id'], 'properties': {'mode': {'enum': ['ultra', 'fast', 'normal', 'deep'], 'type': 'string'}, 'cached': {'type': 'boolean', 'const': True}, 'results': {'type': 'array', 'items': {'type': 'object', 'required': ['title', 'url', 'score'], 'properties': {'url': {'type': 'string'}, 'score': {'type': 'number', 'description': 'Probability that the article is about the query.'}, 'title': {'type': 'string'}, 'source': {'type': 'string'}, 'country': {'type': 'string'}, 'snippet': {'type': 'string', 'description': 'The standfirst, as the outlet published it (shortened).'}, 'found_in': {'enum': ['homepage', 'section', 'site_search', 'discovery'], 'type': 'string', 'description': 'Only when it was not found in the index: where it came from.'}, 'language': {'type': 'string'}, 'highlights': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Short verbatim excerpts from reading the article.'}, 'published_at': {'type': 'string', 'description': 'ISO 8601, UTC, to the minute.'}}, 'additionalProperties': False}}, 'cost_usd': {'type': 'number'}, 'warnings': {'type': 'array', 'items': {'type': 'object', 'required': ['code', 'message'], 'properties': {'code': {'type': 'string'}, 'message': {'type': 'string'}}, 'additionalProperties': False}}, 'reference': {'type': 'object', 'required': ['title', 'url'], 'properties': {'url': {'type': 'string'}, 'title': {'type': 'string'}}, 'additionalProperties': False}, 'incomplete': {'type': 'boolean', 'const': True, 'description': 'The time or token budget ran out: there may be more.'}, 'request_id': {'type': 'string'}, 'near_misses': {'type': 'array', 'items': {'type': 'object', 'required': ['title', 'url', 'score'], 'properties': {'url': {'type': 'string'}, 'score': {'type': 'number', 'description': 'Probability that the article is about the query.'}, 'title': {'type': 'string'}, 'source': {'type': 'string'}, 'country': {'type': 'string'}, 'snippet': {'type': 'string', 'description': 'The standfirst, as the outlet published it (shortened).'}, 'found_in': {'enum': ['homepage', 'section', 'site_search', 'discovery'], 'type': 'string', 'description': 'Only when it was not found in the index: where it came from.'}, 'language': {'type': 'string'}, 'highlights': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Short verbatim excerpts from reading the article.'}, 'published_at': {'type': 'string', 'description': 'ISO 8601, UTC, to the minute.'}}, 'additionalProperties': False}, 'description': 'Only when nothing matched: the closest articles, which may not be about it.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['urls'], 'properties': {'urls': {'type': 'array', 'items': {'type': 'string', 'maxLength': 2000}, 'maxItems': 10, 'minItems': 1, 'description': 'Up to 10 article URLs, such as https://example.com/news/article.'}, 'query': {'type': 'string', 'maxLength': 200, 'minLength': 2, 'description': 'Optional: the excerpt is then the one about this query, with a relevance score.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['results', 'cost_usd', 'request_id'], 'properties': {'results': {'type': 'array', 'items': {'type': 'object', 'required': ['url', 'status'], 'properties': {'url': {'type': 'string'}, 'error': {'type': 'object', 'required': ['code', 'message'], 'properties': {'code': {'type': 'string'}, 'message': {'type': 'string'}}, 'additionalProperties': False}, 'title': {'type': 'string'}, 'source': {'type': 'string'}, 'status': {'enum': ['ok', 'error'], 'type': 'string'}, 'excerpt': {'type': 'string'}, 'relevance': {'type': 'number'}, 'highlights': {'type': 'array', 'items': {'type': 'string'}}, 'description': {'type': 'string'}, 'published_at': {'type': 'string'}}, 'additionalProperties': False}}, 'cost_usd': {'type': 'number'}, 'request_id': {'type': 'string'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['query'], 'properties': {'days': {'type': 'integer', 'maximum': 365, 'minimum': 1, 'description': 'Only the last N days, 1 to 365. Defaults to 7 unless published_after or published_before are given.'}, 'mode': {'enum': ['ultra', 'fast', 'normal', 'deep'], 'type': 'string', 'default': 'fast', 'description': 'fast (default): headlines and standfirsts · ultra (cheapest): headlines only · normal: also reads the best matches · deep: reads more, finds the topic in other words too.'}, 'index': {'type': 'string', 'pattern': '^idx_[a-z0-9]{6,40}$', 'description': 'Optional: search your own custom index (its id, idx_…) instead of the news index: your own list of URLs, sitemap or feed, created at https://app.typesearch.ai/indexes or with POST /v1/indexes. Same modes and prices; no date filter unless you pass days or dates.'}, 'query': {'type': 'string', 'maxLength': 200, 'minLength': 2, 'description': 'What to look for, in any language: a topic, event, person, company or place, such as "inflation in Argentina" or "OpenAI funding".'}, 'countries': {'type': 'array', 'items': {'type': 'string', 'maxLength': 20}, 'maxItems': 50, 'minItems': 1, 'description': 'Only sources from these countries: ISO 3166-1 alpha-2 codes, such as ["AR"] or ["US", "GB"].'}, 'languages': {'type': 'array', 'items': {'type': 'string', 'maxLength': 35}, 'maxItems': 20, 'minItems': 1, 'description': 'Only sources that publish in these languages: ISO 639-1 codes, such as ["es"] or ["en", "pt"].'}, 'max_results': {'type': 'integer', 'default': 10, 'maximum': 25, 'minimum': 1, 'description': 'How many results, 1 to 25. Defaults to 10.'}, 'exclude_domains': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200}, 'maxItems': 20, 'description': 'Never these domains or paths.'}, 'include_domains': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200}, 'maxItems': 20, 'description': 'Only these domains or paths, such as example.com or example.com/sports.'}, 'published_after': {'anyOf': [{'type': 'string', 'format': 'date', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$'}, {'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$'}], 'description': 'Published on or after this date: 2026-09-25, or a date-time with offset.'}, 'published_before': {'anyOf': [{'type': 'string', 'format': 'date', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$'}, {'type': 'string', 'format': 'date-time', 'pattern': '^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$'}], 'description': 'Published on or before this date; a bare date includes that whole day.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['query', 'mode', 'results', 'cost_usd', 'request_id'], 'properties': {'mode': {'enum': ['ultra', 'fast', 'normal', 'deep'], 'type': 'string'}, 'query': {'type': 'string'}, 'cached': {'type': 'boolean', 'const': True}, 'results': {'type': 'array', 'items': {'type': 'object', 'required': ['title', 'url', 'score'], 'properties': {'url': {'type': 'string'}, 'score': {'type': 'number', 'description': 'Probability that the article is about the query.'}, 'title': {'type': 'string'}, 'source': {'type': 'string'}, 'country': {'type': 'string'}, 'snippet': {'type': 'string', 'description': 'The standfirst, as the outlet published it (shortened).'}, 'found_in': {'enum': ['homepage', 'section', 'site_search', 'discovery'], 'type': 'string', 'description': 'Only when it was not found in the index: where it came from.'}, 'language': {'type': 'string'}, 'highlights': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Short verbatim excerpts from reading the article.'}, 'published_at': {'type': 'string', 'description': 'ISO 8601, UTC, to the minute.'}}, 'additionalProperties': False}}, 'cost_usd': {'type': 'number'}, 'warnings': {'type': 'array', 'items': {'type': 'object', 'required': ['code', 'message'], 'properties': {'code': {'type': 'string'}, 'message': {'type': 'string'}}, 'additionalProperties': False}}, 'incomplete': {'type': 'boolean', 'const': True, 'description': 'The time or token budget ran out: there may be more.'}, 'request_id': {'type': 'string'}, 'near_misses': {'type': 'array', 'items': {'type': 'object', 'required': ['title', 'url', 'score'], 'properties': {'url': {'type': 'string'}, 'score': {'type': 'number', 'description': 'Probability that the article is about the query.'}, 'title': {'type': 'string'}, 'source': {'type': 'string'}, 'country': {'type': 'string'}, 'snippet': {'type': 'string', 'description': 'The standfirst, as the outlet published it (shortened).'}, 'found_in': {'enum': ['homepage', 'section', 'site_search', 'discovery'], 'type': 'string', 'description': 'Only when it was not found in the index: where it came from.'}, 'language': {'type': 'string'}, 'highlights': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Short verbatim excerpts from reading the article.'}, 'published_at': {'type': 'string', 'description': 'ISO 8601, UTC, to the minute.'}}, 'additionalProperties': False}, 'description': 'Only when nothing matched: the closest articles, which may not be about it.'}}, 'additionalProperties': False}