Quote, bid and confirm travel upgrades: eligibility, bid range, place/modify/cancel, instant buy.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Answer a general (not booking-specific) travel-upgrade question — how bid/instant/points upgrades work, eligibility rules, bidding strategy, and which airlines, cruise lines, or rail operators offer upgrades. Use this for informational questions only. To check a SPECIFIC booking, use start_eligibility_check (preferred — collects PNR + last name on a secure page).
The traveler's upgrade question, in natural language.
Identifier for the calling agent/app (e.g. 'claude-cowork', 'aircanada-bot'). Used for per-partner reporting on which agents ask about their brand.
Optional stable conversation id — carries the operator in play across follow-up questions (e.g. 'what about the return?').
Answer a general (not booking-specific) travel-upgrade question — how bid/instant/points upgrades work, eligibility rules, bidding strategy, and which airlines, cruise lines, or rail operators offer upgrades. Use this for informational questions only. To check a SPECIFIC booking, use start_eligibility_check (preferred — collects PNR + last name on a secure page).
| Argument | Type | Description |
|---|---|---|
| askedBy | string | Identifier for the calling agent/app (e.g. 'claude-cowork', 'aircanada-bot'). Used for per-partner reporting on which agents ask about their brand. |
| question* | string | The traveler's upgrade question, in natural language. |
| conversationId | string | Optional stable conversation id — carries the operator in play across follow-up questions (e.g. 'what about the return?'). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"question"
],
"properties": {
"askedBy": {
"type": "string",
"description": "Identifier for the calling agent/app (e.g. 'claude-cowork', 'aircanada-bot'). Used for per-partner reporting on which agents ask about their brand."
},
"question": {
"type": "string",
"description": "The traveler's upgrade question, in natural language."
},
"conversationId": {
"type": "string",
"description": "Optional stable conversation id — carries the operator in play across follow-up questions (e.g. 'what about the return?')."
}
},
"additionalProperties": false
}Withdraw a bid already placed on a booking the traveler checked with start_eligibility_check. Pass the sessionId (or conversationId). If the booking has more than one bid, pass orderChangeId to say which — get_bid_status lists them. Confirm with the traveler before calling; this releases the bid.
| Argument | Type | Description |
|---|---|---|
| confirm | boolean | Set true once the traveler has confirmed they want the bid withdrawn. |
| sessionId | string | The sessionId from start_eligibility_check. Optional if conversationId is passed. |
| orderChangeId | string | Which bid to cancel, when the booking has more than one (from get_bid_status). |
| conversationId | string | Stable conversation id (reuses the last checked booking). |
| presentationReport | array | REPORT WHAT YOU SHOWED: if you filtered, hid, or deprioritized ANY offer from the eligibility result before presenting to the traveler, report every offer here with shown + reason. Contains no traveler data; powers partner analytics. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"confirm": {
"type": "boolean",
"description": "Set true once the traveler has confirmed they want the bid withdrawn."
},
"sessionId": {
"type": "string",
"description": "The sessionId from start_eligibility_check. Optional if conversationId is passed."
},
"orderChangeId": {
"type": "string",
"description": "Which bid to cancel, when the booking has more than one (from get_bid_status)."
},
"conversationId": {
"type": "string",
"description": "Stable conversation id (reuses the last checked booking)."
},
"presentationReport": {
"type": "array",
"items": {
"type": "object",
"required": [
"offerId",
"shown"
],
"properties": {
"shown": {
"type": "boolean",
"description": "Whether you actually presented this offer to the traveler."
},
"reason": {
"enum": [
"REASON_PRICE_CEILING",
"REASON_LOW_PROBABILITY",
"REASON_PREFERENCE_CLASH"
],
"type": "string",
"description": "Why it was filtered or deprioritized — supply when shown=false (over budget → REASON_PRICE_CEILING; low acceptance odds → REASON_LOW_PROBABILITY; conflicts with stated preferences → REASON_PREFERENCE_CLASH)."
},
"offerId": {
"type": "string",
"description": "The offer id from the eligibility result's 'Offer ids for presentation reporting' line."
}
},
"additionalProperties": false
},
"description": "REPORT WHAT YOU SHOWED: if you filtered, hid, or deprioritized ANY offer from the eligibility result before presenting to the traveler, report every offer here with shown + reason. Contains no traveler data; powers partner analytics."
}
},
"additionalProperties": false
}Looks up a booking's upgrade eligibility from a booking reference and last name, and airline. Returns eligibility status, upgrade options, bid ranges, and a session id for follow-up bid tools.
| Argument | Type | Description |
|---|---|---|
| pnr* | string | The booking reference or PNR (e.g. ABC123). |
| carrier | string | Airline/cruise/rail name or IATA code (e.g. 'SWISS' or 'LX'). |
| language | string | ISO 639-1 language for the offer page (e.g. 'fr', 'es'). Defaults to 'en'. |
| lastName* | string | Passenger last name, exactly as it appears on the booking. |
| intentContext | object | The traveler's stated shopping intent — bound to the session and surfaced back so offers are presented against it. |
| conversationId | string | Optional stable conversation id — lets place_bid/modify_bid reuse this booking. |
| travelerQuestion | string | The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves the assistant's answers over time. |
Check any bids already on a booking (submitted / accepted / declined), the bid-eligible cabins with their ranges, and the current cart. Pass the sessionId from start_eligibility_check. In hosts that render app widgets it shows a manage screen inline. Use modify_bid / cancel_bid to change or withdraw a bid.
| Argument | Type | Description |
|---|---|---|
| sessionId | string | The sessionId from start_eligibility_check. Optional if conversationId is passed. |
| conversationId | string | Stable conversation id (reuses the last checked booking). |
| presentationReport | array | REPORT WHAT YOU SHOWED: if you filtered, hid, or deprioritized ANY offer from the eligibility result before presenting to the traveler, report every offer here with shown + reason. Contains no traveler data; powers partner analytics. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"sessionId": {
"type": "string",
"description": "The sessionId from start_eligibility_check. Optional if conversationId is passed."
},
"conversationId": {
"type": "string",
"description": "Stable conversation id (reuses the last checked booking)."
},
"presentationReport": {
"type": "array",
"items": {
"type": "object",
"required": [
"offerId",
"shown"
],
"properties": {
"shown": {
"type": "boolean",
"description": "Whether you actually presented this offer to the traveler."
},
"reason": {
"enum": [
"REASON_PRICE_CEILING",
"REASON_LOW_PROBABILITY",
"REASON_PREFERENCE_CLASH"
],
"type": "string",
"description": "Why it was filtered or deprioritized — supply when shown=false (over budget → REASON_PRICE_CEILING; low acceptance odds → REASON_LOW_PROBABILITY; conflicts with stated preferences → REASON_PREFERENCE_CLASH)."
},
"offerId": {
"type": "string",
"description": "The offer id from the eligibility result's 'Offer ids for presentation reporting' line."
}
},
"additionalProperties": false
},
"description": "REPORT WHAT YOU SHOWED: if you filtered, hid, or deprioritized ANY offer from the eligibility result before presenting to the traveler, report every offer here with shown + reason. Contains no traveler data; powers partner analytics."
}
},
"additionalProperties": false
}Read the result of a secure eligibility check started with start_eligibility_check. Pass the sessionId returned by that tool. Returns the live eligibility outcome (eligible options, bid ranges, offer URL) once the passenger has submitted their details on the secure page — or a 'still waiting' status if they haven't yet.
| Argument | Type | Description |
|---|---|---|
| sessionId* | string | The sessionId returned by start_eligibility_check. |
| conversationId | string | Optional stable conversation id — lets later tools (place_bid) reuse this booking without re-passing the sessionId. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sessionId"
],
"properties": {
"sessionId": {
"type": "string",
"description": "The sessionId returned by start_eligibility_check."
},
"conversationId": {
"type": "string",
"description": "Optional stable conversation id — lets later tools (place_bid) reuse this booking without re-passing the sessionId."
}
},
"additionalProperties": false
}Poll for bid-outcome changes on a checked booking without re-running a status check: an ordered log of events (offer.status_changed, offer.accepted, offer.declined, offer.cancelled, checkout.paid) with the offer reference, new and previous status, amount and cabin. Pass the sessionId (or conversationId) and, on later calls, the `since` cursor from the previous response to get only what's new. Bids settle 24–72h before departure, so poll periodically (or subscribe via REST POST /api/v1/webhooks) instead of asking the traveler to check back. Empty means no change observed yet.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max events to return (default 50). |
| since | string | Return only events after this: the `nextCursor` from a previous call, or an ISO-8601 timestamp. |
| sessionId | string | The sessionId from start_eligibility_check. Optional if conversationId is passed. |
| conversationId | string | Stable conversation id (reuses the last checked booking). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Max events to return (default 50)."
},
"since": {
"type": "string",
"description": "Return only events after this: the `nextCursor` from a previous call, or an ISO-8601 timestamp."
},
"sessionId": {
"type": "string",
"description": "The sessionId from start_eligibility_check. Optional if conversationId is passed."
},
"conversationId": {
"type": "string",
"description": "Stable conversation id (reuses the last checked booking)."
}
},
"additionalProperties": false
}Get the full upgrade profile for one operator — products offered (with the official page URL), loyalty program, cabin paths, how to access, and summary. More detailed than ask_upgrade_agent. Accepts an IATA code or a name (e.g. 'AC' or 'Air Canada').
| Argument | Type | Description |
|---|---|---|
| carrier* | string | Operator IATA code or name, e.g. 'LH' or 'Lufthansa'. |
| travelerQuestion | string | The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves the assistant's answers over time. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"carrier"
],
"properties": {
"carrier": {
"type": "string",
"description": "Operator IATA code or name, e.g. 'LH' or 'Lufthansa'."
},
"travelerQuestion": {
"type": "string",
"description": "The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves the assistant's answers over time."
}
},
"additionalProperties": false
}Show the itemized all-in cost of an upgrade before the traveler commits — the amount plus any taxes and fees. Pass the sessionId (or conversationId), the amount (omit it for INSTANT — the airline's fixed price is used), and the cabin/segment if the booking has more than one option. For a BID it also returns the operator's own bid-strength read. Use it to answer 'what will this actually cost me?' before place_bid.
| Argument | Type | Description |
|---|---|---|
| amount | number | The amount to price — a bid in the offer currency, or a number of points for purchaseType POINTS. Omit for INSTANT (fixed price). |
| segment | string | Route 'YUL-LHR' or flight number, if more than one is eligible. |
| sessionId | string | The sessionId from start_eligibility_check. Optional if conversationId is passed. |
| upgradeType | string | |
| purchaseType | string | BID (default), POINTS, or INSTANT (buy now at the airline's fixed price). |
| conversationId | string | Stable conversation id (reuses the last checked booking). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"amount": {
"type": "number",
"description": "The amount to price — a bid in the offer currency, or a number of points for purchaseType POINTS. Omit for INSTANT (fixed price)."
},
"segment": {
"type": "string",
"description": "Route 'YUL-LHR' or flight number, if more than one is eligible."
},
"sessionId": {
"type": "string",
"description": "The sessionId from start_eligibility_check. Optional if conversationId is passed."
},
"upgradeType": {
"enum": [
"BUSINESS",
"FIRST",
"PREMIUM_ECONOMY"
],
"type": "string"
},
"purchaseType": {
"enum": [
"BID",
"POINTS",
"INSTANT"
],
"type": "string",
"description": "BID (default), POINTS, or INSTANT (buy now at the airline's fixed price)."
},
"conversationId": {
"type": "string",
"description": "Stable conversation id (reuses the last checked booking)."
}
},
"additionalProperties": false
}Returns typical upgrade bid ranges (low / typical / high, per cabin) for an operator, aggregated from anonymized eligibility checks. Accepts an IATA code or a name. With an origin and destination airport, the ranges are scoped to that route when observed data exists there (either direction), otherwise the operator-wide ranges are returned and labelled as such. Says so when there isn't enough observed data.
| Argument | Type | Description |
|---|---|---|
| cabin | string | Optional: limit to one target cabin. |
| origin | string | Optional origin airport IATA code (e.g. 'YUL') — scopes the ranges to a route. |
| carrier | string | Operator IATA code or name, e.g. 'LH' or 'Lufthansa'. Optional if conversationId carries the operator from earlier. |
| destination | string | Optional destination airport IATA code (e.g. 'LHR') — scopes the ranges to a route. |
| conversationId | string | Optional stable conversation id — reuses the operator in play. |
| travelerQuestion | string | The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves the assistant's answers over time. |
Check a Watcher Concierge watch (created with start_watch). Returns its status, what it's watching for, and any improvements found so far. Pass the token from start_watch.
| Argument | Type | Description |
|---|---|---|
| token* | string | The watch token returned by start_watch. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"description": "The watch token returned by start_watch."
}
},
"additionalProperties": false
}List the travel operators that offer upgrade programs, with optional filters. Returns each operator's name, IATA/code, vertical, region, and the upgrade products it offers. Use this to build travel workflows or answer 'which airlines/cruise lines offer upgrades'.
| Argument | Type | Description |
|---|---|---|
| region | string | Filter by region (MEA = Middle East & Africa, APAC = Asia-Pacific). |
| product | string | Only operators that offer this product. |
| vertical | string | Filter by operator type. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"region": {
"enum": [
"Americas",
"Europe",
"MEA",
"APAC",
"Cruise",
"Rail"
],
"type": "string",
"description": "Filter by region (MEA = Middle East & Africa, APAC = Asia-Pacific)."
},
"product": {
"enum": [
"bid_upgrade",
"instant_upgrade",
"seat_blocker",
"premium_seating"
],
"type": "string",
"description": "Only operators that offer this product."
},
"vertical": {
"enum": [
"airline",
"cruise",
"rail",
"hotel"
],
"type": "string",
"description": "Filter by operator type."
}
},
"additionalProperties": false
}Internal helper for the inline eligibility form: creates a secure session and returns its id. No UI; agents should use start_eligibility_check instead.
| Argument | Type | Description |
|---|---|---|
| carrier | string | Operator name/IATA if known. |
| language | string | ISO 639-1 language (default 'en'). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"carrier": {
"type": "string",
"description": "Operator name/IATA if known."
},
"language": {
"type": "string",
"description": "ISO 639-1 language (default 'en')."
}
},
"additionalProperties": false
}Change the amount of a bid already prepared/placed on a booking. Same as place_bid but for updating an existing bid — pass the sessionId, the NEW amount, and the cabin/segment if ambiguous. The new amount is validated against the airline's range; payment/confirmation completes on the operator's secure page.
| Argument | Type | Description |
|---|---|---|
| amount* | number | The NEW bid amount in the offer currency. |
| confirm | boolean | Set true to confirm and commit a REAL bid update (human-in-the-loop). Only required once live bid submission is enabled. |
| segment | string | Route 'YUL-LHR' or flight number, if ambiguous. |
| quantity | number | |
| sessionId | string | The sessionId from start_eligibility_check. Optional if conversationId is passed. |
| upgradeType | string | |
| conversationId | string | Stable conversation id (reuses the last checked booking). |
| presentationReport | array | REPORT WHAT YOU SHOWED: if you filtered, hid, or deprioritized ANY offer from the eligibility result before presenting to the traveler, report every offer here with shown + reason. Contains no traveler data; powers partner analytics. |
Per-partner analytics report: what travelers and AI agents are asking about a specific partner's upgrade programs (by intent, by route, most frequent questions, which agents/clients are asking), the AI-check → bid → paid conversion funnel by channel, AI visibility (share of answer per engine, what agents say, where answers are wrong), open content gaps and observed bid ranges. Text summary plus the full report object in structuredContent. Pass the partner name (e.g. 'Air Canada', 'MSC Cruises').
| Argument | Type | Description |
|---|---|---|
| window | string | Report window (default 30d). |
| partner | string | Partner name, slug or IATA code, e.g. 'Air Canada'. Ignored for partner-scoped tokens (locked to their own brand). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"window": {
"enum": [
"7d",
"30d",
"90d"
],
"type": "string",
"description": "Report window (default 30d)."
},
"partner": {
"type": "string",
"description": "Partner name, slug or IATA code, e.g. 'Air Canada'. Ignored for partner-scoped tokens (locked to their own brand)."
}
},
"additionalProperties": false
}AI visibility for one partner's upgrade program: share of answer across the answer engines (ChatGPT, Claude, Perplexity, Gemini) for prompts about that partner, which domains get cited instead, what the agents say about the program, and where the answers are wrong (community claims that contradict the program's facts, plus engine excerpts flagged for human review). Partner-scoped tokens are locked to their own brand.
| Argument | Type | Description |
|---|---|---|
| window | string | Report window (default 30d). |
| partner | string | Partner name, slug or IATA code. Ignored for partner-scoped tokens. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"window": {
"enum": [
"7d",
"30d",
"90d"
],
"type": "string",
"description": "Report window (default 30d)."
},
"partner": {
"type": "string",
"description": "Partner name, slug or IATA code. Ignored for partner-scoped tokens."
}
},
"additionalProperties": false
}Places an upgrade bid, or buys a fixed-price (INSTANT) upgrade, for a checked booking. Takes an eligibility-check session id, an amount (omitted for INSTANT), and a cabin/segment. Returns a secure operator link to complete payment.
| Argument | Type | Description |
|---|---|---|
| amount | number | Bid amount in the offer currency (or points for POINTS). OMIT for INSTANT — the airline's fixed price is used automatically. |
| confirm | boolean | Set true to confirm and commit a REAL bid submission (human-in-the-loop). Only required once live bid submission is enabled; otherwise the bid is staged for secure payment. |
| segment | string | Route 'YUL-LHR' or flight number, if more than one segment is eligible. |
| quantity | number | Number of seats (default 1). |
| sessionId | string | The sessionId from start_eligibility_check. Optional if conversationId is passed (reuses the last checked booking). |
| upgradeType | string | Target cabin, if the booking has more than one eligible option. |
| purchaseType | string | BID (money offer, default), POINTS to redeem loyalty points ('amount' = points), or INSTANT to buy now at the airline's fixed price (no amount needed). |
| conversationId |
Estimates how likely a specific bid amount is to be accepted, grounded in resolved bid outcomes for the carrier cabin, plus the operator's own bid-strength read when a checked booking's session id is provided. Returns null when there isn't enough data.
| Argument | Type | Description |
|---|---|---|
| cabin | string | Optional: target cabin. |
| amount* | number | The bid amount to evaluate, in the operator's offer currency. |
| carrier | string | Operator IATA code or name, e.g. 'LH' or 'Lufthansa'. Optional if conversationId carries the operator from earlier. |
| segment | string | Route 'YUL-LHR' or flight number, if the booking has more than one bid-eligible segment. |
| sessionId | string | The sessionId from start_eligibility_check — unlocks the operator's LIVE bid-strength read for this exact booking and amount. |
| conversationId | string | Optional stable conversation id — reuses the operator (and checked booking) in play. |
| travelerQuestion | string | The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves the assistant's answers over time. |
Finds operators that offer upgrades. With an origin and destination airport (IATA codes, e.g. YUL and LHR) the result is route-level: carriers with observed upgrade pricing on that airport pair (per-cabin ranges from anonymized checks, either direction), carriers confirmed by operator inventory where that upstream is enabled, and carriers whose hub or home country is at one end of the route — the last group is labelled as a hub match that is not confirmed and carries no pricing. Without a route, the result is the operator list filtered by vertical, region, and/or product.
| Argument | Type | Description |
|---|---|---|
| date | string | Optional travel date (YYYY-MM-DD) — used for live inventory confirmation when that upstream is enabled. |
| cabin | string | Optional: limit observed route pricing to one target cabin. |
| origin | string | Origin airport IATA code (e.g. 'YUL'). With destination, filters to that route. |
| region | string | |
| product | string | |
| vertical | string | |
| destination | string | Destination airport IATA code (e.g. 'LHR'). With origin, filters to that route. |
Starts an upgrade eligibility check for a flight, cruise, or rail booking. Returns a secure page (and, where supported, an inline form) for the traveler to enter their booking reference and last name.
| Argument | Type | Description |
|---|---|---|
| carrier | string | Airline/cruise/rail name or IATA code if known (e.g. 'Air Canada' or 'AC'). |
| language | string | ISO 639-1 language for the page/offer (e.g. 'fr', 'es'). Defaults to 'en'. |
| intentContext | object | The traveler's stated shopping intent — bound to the session and surfaced back so offers are presented against it. |
| travelerQuestion | string | The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves the assistant's answers over time. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"carrier": {
"type": "string",
"description": "Airline/cruise/rail name or IATA code if known (e.g. 'Air Canada' or 'AC')."
},
"language": {
"type": "string",
"description": "ISO 639-1 language for the page/offer (e.g. 'fr', 'es'). Defaults to 'en'."
},
"intentContext": {
"type": "object",
"properties": {
"notes": {
"type": "string",
"maxLength": 200,
"description": "Short preference note, e.g. 'anniversary trip, wants lie-flat'. For privacy, leave out booking references and names."
},
"budgetAmount": {
"type": "number",
"description": "Traveler's stated budget for the upgrade.",
"exclusiveMinimum": 0
},
"budgetCurrency": {
"type": "string",
"maxLength": 3,
"description": "ISO currency for the budget, e.g. 'CAD'."
},
"preferredCabin": {
"enum": [
"BUSINESS",
"FIRST",
"PREMIUM_ECONOMY"
],
"type": "string"
}
},
"description": "The traveler's stated shopping intent — bound to the session and surfaced back so offers are presented against it.",
"additionalProperties": false
},
"travelerQuestion": {
"type": "string",
"description": "The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves the assistant's answers over time."
}
},
"additionalProperties": false
}Sets up a Watcher that monitors a traveler's booking between now and departure for upgrade opportunities (a better seat, an empty adjacent seat, a cabin upgrade, lounge, or fast track). Returns a secure card/link where the traveler enters their booking, notification preference, and consent.
| Argument | Type | Description |
|---|---|---|
| carrier | string | Airline/operator name or IATA code if known. |
| contact | object | |
| purpose | string | Is the trip for business or leisure? Tailors the complementary experiences we surface at the destination. |
| channels | array | How to reach them: in_chat | watch_page | email | sms | whatsapp | push. |
| autoAction | boolean | If true (and a budget is set), act within budget; else notify. |
| firstVisit | boolean | Is this the traveler's first time at the destination? Biases toward the classics vs off-the-beaten-path. |
| preferences* | array | The traveler's improvements to watch for, in their order of preference. |
| budgetAmount | number | Overall budget if they want the agent to act. |
Running totals across the whole system: how many questions have been asked, and how many were answered successfully (quality at or above the success threshold).
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"pnr",
"lastName"
],
"properties": {
"pnr": {
"type": "string",
"description": "The booking reference or PNR (e.g. ABC123)."
},
"carrier": {
"type": "string",
"description": "Airline/cruise/rail name or IATA code (e.g. 'SWISS' or 'LX')."
},
"language": {
"type": "string",
"description": "ISO 639-1 language for the offer page (e.g. 'fr', 'es'). Defaults to 'en'."
},
"lastName": {
"type": "string",
"description": "Passenger last name, exactly as it appears on the booking."
},
"intentContext": {
"type": "object",
"properties": {
"notes": {
"type": "string",
"maxLength": 200,
"description": "Short preference note, e.g. 'anniversary trip, wants lie-flat'. For privacy, leave out booking references and names."
},
"budgetAmount": {
"type": "number",
"description": "Traveler's stated budget for the upgrade.",
"exclusiveMinimum": 0
},
"budgetCurrency": {
"type": "string",
"maxLength": 3,
"description": "ISO currency for the budget, e.g. 'CAD'."
},
"preferredCabin": {
"enum": [
"BUSINESS",
"FIRST",
"PREMIUM_ECONOMY"
],
"type": "string"
}
},
"description": "The traveler's stated shopping intent — bound to the session and surfaced back so offers are presented against it.",
"additionalProperties": false
},
"conversationId": {
"type": "string",
"description": "Optional stable conversation id — lets place_bid/modify_bid reuse this booking."
},
"travelerQuestion": {
"type": "string",
"description": "The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves the assistant's answers over time."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"cabin": {
"enum": [
"BUSINESS",
"FIRST",
"PREMIUM_ECONOMY"
],
"type": "string",
"description": "Optional: limit to one target cabin."
},
"origin": {
"type": "string",
"description": "Optional origin airport IATA code (e.g. 'YUL') — scopes the ranges to a route."
},
"carrier": {
"type": "string",
"description": "Operator IATA code or name, e.g. 'LH' or 'Lufthansa'. Optional if conversationId carries the operator from earlier."
},
"destination": {
"type": "string",
"description": "Optional destination airport IATA code (e.g. 'LHR') — scopes the ranges to a route."
},
"conversationId": {
"type": "string",
"description": "Optional stable conversation id — reuses the operator in play."
},
"travelerQuestion": {
"type": "string",
"description": "The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves the assistant's answers over time."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"description": "The NEW bid amount in the offer currency."
},
"confirm": {
"type": "boolean",
"description": "Set true to confirm and commit a REAL bid update (human-in-the-loop). Only required once live bid submission is enabled."
},
"segment": {
"type": "string",
"description": "Route 'YUL-LHR' or flight number, if ambiguous."
},
"quantity": {
"type": "number"
},
"sessionId": {
"type": "string",
"description": "The sessionId from start_eligibility_check. Optional if conversationId is passed."
},
"upgradeType": {
"enum": [
"BUSINESS",
"FIRST",
"PREMIUM_ECONOMY"
],
"type": "string"
},
"conversationId": {
"type": "string",
"description": "Stable conversation id (reuses the last checked booking)."
},
"presentationReport": {
"type": "array",
"items": {
"type": "object",
"required": [
"offerId",
"shown"
],
"properties": {
"shown": {
"type": "boolean",
"description": "Whether you actually presented this offer to the traveler."
},
"reason": {
"enum": [
"REASON_PRICE_CEILING",
"REASON_LOW_PROBABILITY",
"REASON_PREFERENCE_CLASH"
],
"type": "string",
"description": "Why it was filtered or deprioritized — supply when shown=false (over budget → REASON_PRICE_CEILING; low acceptance odds → REASON_LOW_PROBABILITY; conflicts with stated preferences → REASON_PREFERENCE_CLASH)."
},
"offerId": {
"type": "string",
"description": "The offer id from the eligibility result's 'Offer ids for presentation reporting' line."
}
},
"additionalProperties": false
},
"description": "REPORT WHAT YOU SHOWED: if you filtered, hid, or deprioritized ANY offer from the eligibility result before presenting to the traveler, report every offer here with shown + reason. Contains no traveler data; powers partner analytics."
}
},
"additionalProperties": false
}| string |
| Stable conversation id used on get_eligibility_result — lets you bid without re-passing the sessionId. |
| presentationReport | array | REPORT WHAT YOU SHOWED: if you filtered, hid, or deprioritized ANY offer from the eligibility result before presenting to the traveler, report every offer here with shown + reason. Contains no traveler data; powers partner analytics. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"amount": {
"type": "number",
"description": "Bid amount in the offer currency (or points for POINTS). OMIT for INSTANT — the airline's fixed price is used automatically."
},
"confirm": {
"type": "boolean",
"description": "Set true to confirm and commit a REAL bid submission (human-in-the-loop). Only required once live bid submission is enabled; otherwise the bid is staged for secure payment."
},
"segment": {
"type": "string",
"description": "Route 'YUL-LHR' or flight number, if more than one segment is eligible."
},
"quantity": {
"type": "number",
"description": "Number of seats (default 1)."
},
"sessionId": {
"type": "string",
"description": "The sessionId from start_eligibility_check. Optional if conversationId is passed (reuses the last checked booking)."
},
"upgradeType": {
"enum": [
"BUSINESS",
"FIRST",
"PREMIUM_ECONOMY"
],
"type": "string",
"description": "Target cabin, if the booking has more than one eligible option."
},
"purchaseType": {
"enum": [
"BID",
"POINTS",
"INSTANT"
],
"type": "string",
"description": "BID (money offer, default), POINTS to redeem loyalty points ('amount' = points), or INSTANT to buy now at the airline's fixed price (no amount needed)."
},
"conversationId": {
"type": "string",
"description": "Stable conversation id used on get_eligibility_result — lets you bid without re-passing the sessionId."
},
"presentationReport": {
"type": "array",
"items": {
"type": "object",
"required": [
"offerId",
"shown"
],
"properties": {
"shown": {
"type": "boolean",
"description": "Whether you actually presented this offer to the traveler."
},
"reason": {
"enum": [
"REASON_PRICE_CEILING",
"REASON_LOW_PROBABILITY",
"REASON_PREFERENCE_CLASH"
],
"type": "string",
"description": "Why it was filtered or deprioritized — supply when shown=false (over budget → REASON_PRICE_CEILING; low acceptance odds → REASON_LOW_PROBABILITY; conflicts with stated preferences → REASON_PREFERENCE_CLASH)."
},
"offerId": {
"type": "string",
"description": "The offer id from the eligibility result's 'Offer ids for presentation reporting' line."
}
},
"additionalProperties": false
},
"description": "REPORT WHAT YOU SHOWED: if you filtered, hid, or deprioritized ANY offer from the eligibility result before presenting to the traveler, report every offer here with shown + reason. Contains no traveler data; powers partner analytics."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"amount"
],
"properties": {
"cabin": {
"enum": [
"BUSINESS",
"FIRST",
"PREMIUM_ECONOMY"
],
"type": "string",
"description": "Optional: target cabin."
},
"amount": {
"type": "number",
"description": "The bid amount to evaluate, in the operator's offer currency."
},
"carrier": {
"type": "string",
"description": "Operator IATA code or name, e.g. 'LH' or 'Lufthansa'. Optional if conversationId carries the operator from earlier."
},
"segment": {
"type": "string",
"description": "Route 'YUL-LHR' or flight number, if the booking has more than one bid-eligible segment."
},
"sessionId": {
"type": "string",
"description": "The sessionId from start_eligibility_check — unlocks the operator's LIVE bid-strength read for this exact booking and amount."
},
"conversationId": {
"type": "string",
"description": "Optional stable conversation id — reuses the operator (and checked booking) in play."
},
"travelerQuestion": {
"type": "string",
"description": "The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves the assistant's answers over time."
}
},
"additionalProperties": false
}| travelerQuestion |
| string |
| The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves the assistant's answers over time. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"date": {
"type": "string",
"description": "Optional travel date (YYYY-MM-DD) — used for live inventory confirmation when that upstream is enabled."
},
"cabin": {
"enum": [
"BUSINESS",
"FIRST",
"PREMIUM_ECONOMY"
],
"type": "string",
"description": "Optional: limit observed route pricing to one target cabin."
},
"origin": {
"type": "string",
"description": "Origin airport IATA code (e.g. 'YUL'). With destination, filters to that route."
},
"region": {
"enum": [
"Americas",
"Europe",
"MEA",
"APAC",
"Cruise",
"Rail"
],
"type": "string"
},
"product": {
"enum": [
"bid_upgrade",
"instant_upgrade",
"seat_blocker",
"premium_seating"
],
"type": "string"
},
"vertical": {
"enum": [
"airline",
"cruise",
"rail",
"hotel"
],
"type": "string"
},
"destination": {
"type": "string",
"description": "Destination airport IATA code (e.g. 'LHR'). With origin, filters to that route."
},
"travelerQuestion": {
"type": "string",
"description": "The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves the assistant's answers over time."
}
},
"additionalProperties": false
}| budgetCurrency |
| string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"preferences"
],
"properties": {
"carrier": {
"type": "string",
"description": "Airline/operator name or IATA code if known."
},
"contact": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"phone": {
"type": "string",
"description": "Mobile number for SMS (E.164, e.g. +14155551234)."
},
"whatsapp": {
"type": "string"
}
},
"additionalProperties": false
},
"purpose": {
"enum": [
"business",
"leisure"
],
"type": "string",
"description": "Is the trip for business or leisure? Tailors the complementary experiences we surface at the destination."
},
"channels": {
"type": "array",
"items": {
"type": "string"
},
"description": "How to reach them: in_chat | watch_page | email | sms | whatsapp | push."
},
"autoAction": {
"type": "boolean",
"description": "If true (and a budget is set), act within budget; else notify."
},
"firstVisit": {
"type": "boolean",
"description": "Is this the traveler's first time at the destination? Biases toward the classics vs off-the-beaten-path."
},
"preferences": {
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"rank": {
"type": "number",
"description": "1 = most wanted."
},
"type": {
"type": "string",
"description": "e.g. window_seat | aisle_seat | extra_legroom | empty_seat | premium_economy | business_upgrade | first_upgrade | lounge | fast_track"
},
"currency": {
"type": "string"
},
"maxAmount": {
"type": "number",
"description": "Optional budget cap for this perk."
}
},
"additionalProperties": false
},
"description": "The traveler's improvements to watch for, in their order of preference."
},
"budgetAmount": {
"type": "number",
"description": "Overall budget if they want the agent to act."
},
"budgetCurrency": {
"type": "string"
}
},
"additionalProperties": false
}