travel-insurance

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'cardId': {'type': 'number', 'description': 'Exact HelloSafe card ID from a previous call â\x80\x94 use it to re-check a specific candidate instead of fuzzy matching.'}, 'locale': {'type': 'string', 'description': 'Language the user is conversing in, as a BCP 47 tag or 2-letter code (e.g. "fr", "pt-BR"). ALWAYS pass it.'}, 'network': {'type': 'string', 'description': 'Card network when stated: "Visa", "Mastercard", "Amex".'}, 'cardQuery': {'type': 'string', 'description': 'Card name as the user said it, expanded ("American Express Platinum", not "Amex Plat"). Include the bank when known ("Chase Sapphire Reserve"). Omit only when cardId is provided.'}, 'bankCountry': {'type': 'string', 'description': 'ISO-2 country of the issuing bank (e.g. "US", "FR"). Defaults to the user\'s country of residence when known â\x80\x94 greatly improves matching.'}, 'tripContext': {'type': 'object', 'properties': {'intent': {'type': 'string', 'description': 'Trip purpose when known â\x80\x94 same values as get_quote (forTourism, mountainTrip, schengenAreaâ\x80¦). Drives the thresholds (e.g. ski cover checked for mountainTrip).'}, 'arrivalCountries': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[A-Za-z]{2}$'}, 'description': 'Destination countries as ISO-2 codes, when the user mentioned a trip.'}, 'shouldCoverCancellation': {'type': 'boolean', 'description': 'True when the user cares about cancellation cover.'}, 'shouldCoverExtremeSports': {'type': 'boolean', 'description': 'True for ski / diving / mountaineering trips.'}}, 'description': 'Optional trip details â\x80\x94 sharpen the gap analysis. Omit what you do not know.'}}}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'card': {'type': 'object', 'properties': {'id': {'type': 'number', 'description': 'HelloSafe card ID â\x80\x94 pass to get_quote as `cardId` to get offers that complement this card, or back to this tool to re-check a specific candidate.'}, 'name': {'type': 'string', 'description': 'Card commercial name.'}, 'score': {'type': 'number', 'description': 'HelloSafe score for the card travel cover.'}, 'network': {'type': 'string', 'description': 'Visa, Mastercard, Amexâ\x80¦'}, 'bankName': {'type': 'string'}, 'currency': {'type': 'string', 'description': 'Currency of the card guarantee amounts.'}, 'bankCountry': {'type': 'string', 'description': 'ISO-2 country of the issuing bank.'}}, 'description': 'The card the analysis is about.', 'additionalProperties': {}}, 'gaps': {'type': 'array', 'items': {'type': 'object', 'properties': {'slug': {'type': 'string', 'description': 'Offer feature slug that fills this gap.'}, 'label': {'type': 'string'}, 'reason': {'type': 'string', 'description': 'not_covered | misleading | below_recommended | below_destination_threshold.'}, 'cardCoverage': {'type': 'string', 'description': 'What the card actually provides, for contrast.'}, 'thresholdLabel': {'type': 'string', 'description': 'Why the amount is considered insufficient.'}}, 'additionalProperties': {}}, 'description': 'Guarantees missing or insufficient for the trip â\x80\x94 the offer features a complementary policy should provide.'}, 'error': {'type': 'string', 'description': 'Human-readable reason when the check could not run. Absent on success.'}, 'covered': {'type': 'array', 'items': {'type': 'object', 'properties': {'slug': {'type': 'string', 'description': 'Feature slug â\x80\x94 same slugs as get_quote offer features.'}, 'badge': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'excellent | covered | misleading | not_covered.'}, 'label': {'type': 'string'}, 'coverage': {'type': 'string', 'description': 'Formatted covered amount from the card T&Cs.'}, 'franchise': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Deductible, when any.'}, 'conditions': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Conditions for the guarantee to apply (e.g. trip paid with the card).'}, 'exclusions': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, 'description': 'Travel guarantees the card really includes, with amounts and conditions from the card T&Cs.'}, 'unknown': {'type': 'array', 'items': {'type': 'object', 'properties': {'slug': {'type': 'string'}, 'label': {'type': 'string'}}, 'additionalProperties': {}}, 'description': 'Core guarantees with no data on this card â\x80\x94 phrase as "not documented, check your contract", never as "not covered".'}, 'alternatives': {'type': 'array', 'items': {'type': 'object', 'properties': {'id': {'type': 'number', 'description': 'HelloSafe card ID â\x80\x94 pass to get_quote as `cardId` to get offers that complement this card, or back to this tool to re-check a specific candidate.'}, 'name': {'type': 'string', 'description': 'Card commercial name.'}, 'score': {'type': 'number', 'description': 'HelloSafe score for the card travel cover.'}, 'network': {'type': 'string', 'description': 'Visa, Mastercard, Amexâ\x80¦'}, 'bankName': {'type': 'string'}, 'currency': {'type': 'string', 'description': 'Currency of the card guarantee amounts.'}, 'bankCountry': {'type': 'string', 'description': 'ISO-2 country of the issuing bank.'}}, 'additionalProperties': {}}, 'description': "Other cards matching the query. If the analysed card is not the user's, ask which one and call again with its cardId."}, 'allGuarantees': {'type': 'array', 'items': {'type': 'object', 'properties': {'tab': {'type': 'string', 'description': 'Section key: travelInsurance | carRental | winterSports | protection.'}, 'features': {'type': 'array', 'items': {'type': 'object', 'properties': {'slug': {'type': 'string'}, 'label': {'type': 'string'}, 'verdict': {'type': 'string', 'description': 'excellent | ok | below_recommended | misleading | not_covered.'}, 'coverage': {'type': 'string', 'description': 'What the card provides, formatted.'}, 'franchise': {'type': 'string'}, 'conditions': {'type': 'string'}, 'recommended': {'type': 'string', 'description': 'The coverage HelloSafe recommends, when defined.'}}, 'additionalProperties': {}}}, 'tabLabel': {'type': 'string', 'description': 'Human-readable section title.'}}, 'additionalProperties': {}}, 'description': "The card's FULL guarantee sheet, grouped by section (travel first) â\x80\x94 render as one markdown table per section: Guarantee | Your card | Recommended | Verdict."}, '_assistantGuidance': {'type': 'object', 'properties': {'instruction': {'type': 'string'}}, 'additionalProperties': {}}, 'cancellationOnlyGap': {'type': 'boolean', 'description': 'True when cancellation is the ONLY gap â\x80\x94 suggest a cancellation-only policy (intent "cancellation" in get_quote), usually much cheaper.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['tripInfo'], 'properties': {'cardId': {'type': 'number', 'description': "HelloSafe card ID returned by check_card_coverage. Pass it when the user holds a credit card with travel cover: offers are then re-ranked by how well they fill that card's coverage gaps, and each offer lists what it adds over the card (complementsCard)."}, 'locale': {'type': 'string', 'description': 'Language the user is conversing in, as a BCP 47 tag or 2-letter code (e.g. "fr", "pt-BR"). ALWAYS pass it â\x80\x94 the widget and all offer texts are localized with it. Falls back to the ChatGPT account locale, then to English.'}, 'tripInfo': {'type': 'object', 'required': ['countryResidence', 'arrivalCountries', 'travellers'], 'properties': {'intent': {'enum': ['forTourism', 'schengenArea', 'annual', 'studyInternship', 'whv', 'cruise', 'digitalNomad', 'expat', 'groupTravel', 'rentalStay', 'mountainTrip', 'backToHome', 'humanitarian', 'auPair', 'toWork', 'cancellation'], 'type': 'string', 'description': 'Trip purpose. Map from the user message when clear: leisure / holidays / sightseeing â\x86\x92 "forTourism"; study abroad, Erasmus, internship â\x86\x92 "studyInternship"; working-holiday visa (PVT) â\x86\x92 "whv"; yearly multi-trip cover â\x86\x92 "annual"; long-term relocation â\x86\x92 "expat"; cancellation-only (no medical) â\x86\x92 "cancellation"; ski / trek / mountaineering â\x86\x92 "mountainTrip"; cruise â\x86\x92 "cruise"; remote-work nomading â\x86\x92 "digitalNomad"; group of 10+ travellers â\x86\x92 "groupTravel"; Schengen visa application â\x86\x92 "schengenArea"; humanitarian mission or volunteering â\x86\x92 "humanitarian"; au pair placement â\x86\x92 "auPair"; business / work trip â\x86\x92 "toWork"; returning home for a visit â\x86\x92 "backToHome"; rental / Airbnb stay focus â\x86\x92 "rentalStay". If you cannot confidently map the user\'s situation to one of these values, ASK THE USER which purpose fits best â\x80\x94 do not guess. Note: "annual" and "expat" automatically force isAnnual=true.'}, 'endDate': {'type': 'string', 'description': 'Trip end date (YYYY-MM-DD). Either endDate or durationDays must be provided (or use intent="annual"/"expat").'}, 'currency': {'type': 'string', 'description': 'ISO 4217 code for tripPrice. Defaults to the currency of countryResidence. Only pass if the user gave an explicit amount in another currency.'}, 'isAnnual': {'type': 'boolean', 'description': 'Annual / multi-trip cover. Defaults to false (auto-true for intent="annual" or "expat").'}, 'startDate': {'type': 'string', 'description': 'Trip start date (YYYY-MM-DD). Defaults to tomorrow when omitted.'}, 'tripPrice': {'type': 'number', 'description': 'TOTAL trip cost for ALL travellers (not per traveller). Omit unless the user explicitly asked for cancellation coverage.'}, 'travellers': {'type': 'array', 'items': {'type': 'object', 'required': ['age'], 'properties': {'age': {'type': 'number', 'description': 'Age in years, 0â\x80\x9399.'}}}, 'description': 'All travellers covered by the policy, including children. Example: a couple aged 35 with a 5-year-old â\x86\x92 [{age:35},{age:35},{age:5}].'}, 'durationDays': {'type': 'integer', 'maximum': 9007199254740991, 'description': 'Trip length in days. Use this instead of endDate when the user gave a duration (e.g. "20 days") â\x80\x94 the server computes endDate = startDate + durationDays.', 'exclusiveMinimum': 0}, 'studiesAmount': {'type': 'number', 'description': 'Tuition fees to cover, in tripInfo.currency. Required when studiesInterruption=true.'}, 'stateResidence': {'type': 'string', 'pattern': '^[A-Za-z]{2}$', 'description': 'State of residence as its USPS 2-letter code (e.g. "CA", "TX") â\x80\x94 for US residents only, ignored for every other country. US travel insurance is regulated state by state, so when countryResidence is "US" ASK THE USER which state they live in and pass it; never guess it from the destination or the chat language. The quote is still produced without it. The US territories are countries here, not states (a Puerto Rico resident is countryResidence "PR", never "US" + "PR").'}, 'tripBoughtDate': {'type': 'string', 'description': 'Date the trip was booked (YYYY-MM-DD). Required when shouldCoverCancellation=true (most insurers require booking within ~30 days).'}, 'arrivalCountries': {'anyOf': [{'type': 'array', 'items': {'type': 'string', 'pattern': '^[A-Za-z]{2}$'}}, {'type': 'string'}], 'description': 'Destination countries as ISO 3166-1 alpha-2 codes. Prefer an array (["TH","VN"]); a comma-separated string also works.'}, 'countryResidence': {'type': 'string', 'pattern': '^[A-Za-z]{2}$', 'description': 'User\'s country of residence as ISO 3166-1 alpha-2 code (e.g. "FR"). Ask the user if they did not state it â\x80\x94 do not infer from destination or chat language.'}, 'studiesInterruption': {'type': 'boolean', 'description': 'Cover interrupted studies (intent="studyInternship" only). Defaults to false. Requires studiesAmount when true.'}, 'shouldCoverCancellation': {'type': 'boolean', 'description': 'Include trip cancellation coverage. Defaults to false.'}, 'shouldCoverExtremeSports': {'type': 'boolean', 'description': 'Cover extreme sports (mountaineering, off-piste skiing, diving, paragliding, climbing). Defaults to false; set true only if the user mentioned such activities.'}}, 'description': 'Trip details.'}, 'subscriptionId': {'type': 'string', 'description': 'Existing subscription ID to update instead of creating a new one.'}, 'displayCurrency': {'type': 'string', 'description': 'ISO 4217 code to override the widget display currency. Omit unless the user explicitly asked for a different display currency than the trip-cost currency.'}}}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'error': {'type': 'string', 'description': 'Human-readable reason when the quote could not be generated. Absent on success.'}, 'tripInfo': {'type': 'object', 'properties': {'endDate': {'type': 'string'}, 'currency': {'type': 'string', 'description': 'ISO 4217 currency the amounts are shown in.'}, 'isAnnual': {'type': 'boolean'}, 'startDate': {'type': 'string'}, 'tripPrice': {'type': 'number', 'description': 'Trip cost per traveller; -1 when not provided.'}, 'intentName': {'type': 'string', 'description': 'Human-readable trip purpose.'}, 'travellers': {'type': 'array', 'items': {'type': 'object', 'properties': {'age': {'type': 'number'}}, 'additionalProperties': {}}}, 'endDateLabel': {'type': 'string'}, 'numberOfDays': {'type': 'number'}, 'tripPriceText': {'type': 'string'}, 'startDateLabel': {'type': 'string'}, 'tripBoughtDateLabel': {'type': 'string'}, 'countryResidenceCode': {'type': 'string'}, 'countryResidenceName': {'type': 'string'}, 'arrivalCountriesCodes': {'type': 'array', 'items': {'type': 'string'}}, 'arrivalCountriesNames': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Destination country names in the response locale.'}, 'shouldCoverCancellation': {'type': 'boolean'}}, 'description': 'Normalized trip parameters the quote was computed with.', 'additionalProperties': {}}, 'cardContext': {'type': 'object', 'properties': {'gaps': {'type': 'array', 'items': {}, 'description': 'The card coverage gaps that drove the offer ranking.'}, 'cardId': {'type': 'number'}, 'unknown': {'type': 'array', 'items': {}}, 'cardName': {'type': 'string'}, 'cancellationOnlyGap': {'type': 'boolean'}}, 'description': 'Present only when the quote was computed against a card (cardId argument): the card and its gaps.', 'additionalProperties': {}}, 'subscribeUrl': {'type': 'string', 'description': 'HelloSafe comparator URL for this quote. The widget already renders clickable buttons â\x80\x94 never paste it in the reply.'}, 'translations': {'type': 'object', 'description': 'Localized UI strings consumed by the widget â\x80\x94 not meant for the assistant.', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}, 'displayOffers': {'type': 'array', 'items': {'type': 'object', 'properties': {'id': {'type': 'number', 'description': 'HelloSafe offer ID.'}, 'faq': {'type': 'array', 'items': {}, 'description': 'Frequently asked questions about this offer.'}, 'name': {'type': 'string', 'description': 'Commercial name of the offer / formula.'}, 'noList': {'type': 'string', 'description': 'Newline-separated list of exclusions.'}, 'suffix': {'type': 'string', 'description': 'Price period suffix key: "perMonth", "perYear", "perDay" or empty.'}, 'yesList': {'type': 'string', 'description': 'Newline-separated list of advantages.'}, 'features': {'type': 'object', 'description': 'Coverage feature slug â\x86\x92 formatted covered amount, already filtered for the trip purpose and converted to the display currency.', 'propertyNames': {'type': 'string'}, 'additionalProperties': {'type': 'string'}}, 'topBanner': {'type': 'string', 'description': 'Short marketing highlight for this offer, if any.'}, 'priceParts': {'type': 'object', 'properties': {'symbol': {'type': 'string'}, 'decimal': {'type': 'string'}, 'integer': {'type': 'string'}, 'symbolPosition': {'type': 'string', 'description': '"prefix" or "suffix".'}, 'decimalSeparator': {'type': 'string'}}, 'description': 'Price split into rendering parts (used by the widget).', 'additionalProperties': {}}, 'insurerName': {'type': 'string', 'description': 'Insurer brand name.'}, 'isBestScore': {'type': 'boolean', 'description': 'True for the single offer HelloSafe recommends for this trip (shown first).'}, 'subscribeUrl': {'type': 'string', 'description': 'HelloSafe comparator URL for this quote. The widget already renders it as a button â\x80\x94 never paste it in the reply.'}, 'priceFullText': {'type': 'string', 'description': 'Total price for the whole trip and all travellers, formatted in the display currency (e.g. "34,20 â\x82¬").'}, 'insurerLogoUrl': {'type': 'string', 'description': 'Absolute URL of the insurer logo.'}, 'complementsCard': {'type': 'array', 'items': {'type': 'string'}, 'description': "Only when the quote carries a cardId: labels of the card's coverage gaps this offer fills â\x80\x94 what it adds over the user's card."}, 'isStartingPrice': {'type': 'boolean', 'description': 'True when the price is a "from" price.'}}, 'additionalProperties': {}}, 'description': 'Priced offers sorted by price, with the recommended offer (isBestScore=true) promoted first.'}, 'subscriptionId': {'type': 'string', 'description': 'Quote session ID â\x80\x94 pass it back as `subscriptionId` to update this quote instead of creating a new one.'}, '_assistantGuidance': {'type': 'object', 'properties': {'instruction': {'type': 'string', 'description': 'How the assistant should present the result to the user.'}, 'recommendedOffer': {'anyOf': [{'type': 'object', 'properties': {'name': {'type': 'string'}, 'price': {'type': 'string'}, 'coverages': {'type': 'object', 'description': 'Coverage label â\x86\x92 covered amount for the recommended offer.', 'propertyNames': {'type': 'string'}, 'additionalProperties': {'type': 'string'}}, 'insurerName': {'type': 'string'}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Compact summary of the offer HelloSafe recommends for this trip.'}}, 'description': 'Guidance for the assistant reply â\x80\x94 follow "instruction".', 'additionalProperties': {}}}, 'additionalProperties': False}