Skyscanner

Destination IATA code. May be either a 3-letter airport code (e.g. CDG, DXB) or a 3-letter city/metropolitan code covering multiple airports (e.g. PAR, NYC). Map the user’s natural-language destination to the appropriate IATA city or airport code. If destination is not provided, prompt the user to specify a destination city or airport before searching (e.g. Paris or Paris Charles de Gaulle). If the user specifies a location that does not map to an IATA city or airport (e.g. a point of interest, neighbourhood, region, country, continent, or “anywhere”), apply the following rules: - If the location clearly maps to a single city with high confidence (e.g. “Eiffel Tower” → Paris), infer and use the corresponding city or airport code (e.g. PAR). - If the location is broad or ambiguous (e.g. “France”, “Europe”), do not guess; prompt the user to specify a destination city or airport. - For any other ambiguity where destination cannot be inferred, prompt the user to specify a destination city or airport before searching.

User locale identifier (e.g. en-GB, en-US, de-DE). Follows BCP 47, composed of an ISO 639-1 language code and an ISO 3166-1 Alpha-2 region code. Used to indicate language and regional preferences for the tool response and UI display if present, including localisation, formatting conventions, and text direction (e.g. left-to-right or right-to-left). If the user explicitly specifies a language or locale, set the locale accordingly (e.g. requesting results in French → fr-FR). Otherwise, infer it from available context (e.g. input language, prior preferences, or other relevant signals). Do not infer locale from route-related data such as: - flight origin or destination - country or city names mentioned in the route

Month to search for flights (1-12, where 1=January, 12=December).

Origin IATA code. May be either a 3-letter airport code (e.g. LHR) or a 3-letter city/metropolitan code covering multiple airports (e.g. LON, NYC). Map the user’s natural-language location to the appropriate IATA code (e.g. “London”/"LDN" → LON, “Heathrow” → LHR). If origin is not provided, infer the most relevant origin only when there is high confidence from available context (e.g. user location or prior conversation state). Do not infer origin from locale, as language is a weak signal for travel origin. If the user specifies a location that does not map to an IATA city or airport (e.g. a point of interest, neighbourhood, region, country, continent, or “anywhere”), apply the following rules: - If the location clearly maps to a single city with high confidence (e.g. “Big Ben”, “Shoreditch” → London), infer and use the corresponding city or airport code (e.g. LON). - If the specified location is broad or ambiguous (e.g. “UK”, “Europe”, “USA”), do not guess. Prompt the user to specify an origin city or airport before searching. - For any other ambiguity where origin cannot be inferred with confidence, prompt the user to specify an origin city or airport before searching.

Year to search for flights (must be current year or next year) Combined with month field to define the target calendar month. The combination of month and year should be at most 1 year ahead of the current year.

Currency code for prices (e.g. GBP, USD, EUR). Only populate this field if the user explicitly requests a currency (e.g. “show in USD”). Otherwise, leave it unset.

Whether to search for return flights. Set to TRUE (return) when the user: - mentions "return"/"round-trip", - specifies date range (e.g., "15th-20th May"), - specifies duration (e.g., "for a weekend"), or unspecified. Set to FALSE (one-way) when the user: - mentions "one-way/single". Defaults to TRUE (return) when there is no clear signal of user intent.

Destination IATA code. May be either a 3-letter airport code (e.g. CDG, DXB) or a 3-letter city/metropolitan code covering multiple airports (e.g. PAR, NYC). Map the user’s natural-language destination to the appropriate IATA city or airport code. If destination is not provided, prompt the user to specify a destination city or airport before searching (e.g. Paris or Paris Charles de Gaulle). If the user specifies a location that does not map to an IATA city or airport (e.g. a point of interest, neighbourhood, region, country, continent, or “anywhere”), apply the following rules: - If the location clearly maps to a single city with high confidence (e.g. “Eiffel Tower” → Paris), infer and use the corresponding city or airport code (e.g. PAR). - If the location is broad or ambiguous (e.g. “France”, “Europe”), do not guess; prompt the user to specify a destination city or airport. - For any other ambiguity where destination cannot be inferred, prompt the user to specify a destination city or airport before searching.

User locale identifier (e.g. en-GB, en-US, de-DE). Follows BCP 47, composed of an ISO 639-1 language code and an ISO 3166-1 Alpha-2 region code. Used to indicate language and regional preferences for the tool response and UI display if present, including localisation, formatting conventions, and text direction (e.g. left-to-right or right-to-left). If the user explicitly specifies a language or locale, set the locale accordingly (e.g. requesting results in French → fr-FR). Otherwise, infer it from available context (e.g. input language, prior preferences, or other relevant signals). Do not infer locale from route-related data such as: - flight origin or destination - country or city names mentioned in the route

Origin IATA code. May be either a 3-letter airport code (e.g. LHR) or a 3-letter city/metropolitan code covering multiple airports (e.g. LON, NYC). Map the user’s natural-language location to the appropriate IATA code (e.g. “London”/"LDN" → LON, “Heathrow” → LHR). If origin is not provided, infer the most relevant origin only when there is high confidence from available context (e.g. user location or prior conversation state). Do not infer origin from locale, as language is a weak signal for travel origin. If the user specifies a location that does not map to an IATA city or airport (e.g. a point of interest, neighbourhood, region, country, continent, or “anywhere”), apply the following rules: - If the location clearly maps to a single city with high confidence (e.g. “Big Ben”, “Shoreditch” → London), infer and use the corresponding city or airport code (e.g. LON). - If the specified location is broad or ambiguous (e.g. “UK”, “Europe”, “USA”), do not guess. Prompt the user to specify an origin city or airport before searching. - For any other ambiguity where origin cannot be inferred with confidence, prompt the user to specify an origin city or airport before searching.

Cabin class enum value (e.g., CABIN_CLASS_ECONOMY, CABIN_CLASS_PREMIUM_ECONOMY, CABIN_CLASS_BUSINESS, CABIN_CLASS_FIRST). Defaults to CABIN_CLASS_ECONOMY.

Currency code for prices (e.g. GBP, USD, EUR). Only populate this field if the user explicitly requests a currency (e.g. “show in USD”). Otherwise, leave it unset.

Optional inbound journey date (e.g., 2025-01-25).

Outbound journey date (no time, no timezone) (e.g., 2025-01-25). Defaults to tomorrow.

Optional sorting preference enum value to sort the results. (e.g., BEST, CHEAPEST, FASTEST). Defaults to BEST.

A unique token identifying the live pricing session created earlier. Use this to poll for updated flight prices or session completion status.

A unique correlation id linking together calls between the create and poll. This is used to correlate FE and BE events between calls.