Predict Bid Success
predict_bid_successEstimates how likely a specific bid amount is to be accepted, grounded in Plusgrade's resolved bid outcomes for the carrier and 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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cabin | No | Optional: target cabin. | |
| amount | Yes | The bid amount to evaluate, in the operator's offer currency. | |
| carrier | No | Operator IATA code or name, e.g. 'LH' or 'Lufthansa'. Optional if conversationId carries the operator from earlier. | |
| segment | No | Route 'YUL-LHR' or flight number, if the booking has more than one bid-eligible segment. | |
| sessionId | No | The sessionId from start_eligibility_check — unlocks the operator's LIVE bid-strength read for this exact booking and amount. | |
| conversationId | No | Optional stable conversation id — reuses the operator (and checked booking) in play. | |
| travelerQuestion | No | 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 Upgrade Agent's answers over time. |