# WestIQ Partner Documentation

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.westiq.ai/_mcp/server

## Docs

- [WestIQ Partner Documentation](https://docs.westiq.ai/getting-started/introduction.md): Integrate with the WestIQ Platform API.
- [Quickstart](https://docs.westiq.ai/getting-started/quickstart.md): Get a token and make your first WestIQ Platform API call.
- [Authentication & Access](https://docs.westiq.ai/guides/authentication.md): OAuth 2.0 client credentials, credential-bound tenancy, and the auth failures you can hit.
- [Sessions & Member Locators](https://docs.westiq.ai/guides/sessions.md): The X-Session-Id header, seat/member locators, and the age-tier model the personalization endpoints share.
- [Search](https://docs.westiq.ai/guides/search.md): Natural-language catalog search — query understanding, franchise & time-aware queries, opt-in personalization, scoring, and coverage.
- [Behavioral Events](https://docs.westiq.ai/guides/behavioral-events.md): Batch passenger interaction signals into POST /v1/events — the batch model, rejection codes, idempotency, and the signal vocabulary.
- [Theme](https://docs.westiq.ai/guides/theme.md): GET /v1/theme — the seatback UI theme for your airline.
- [Session Setup](https://docs.westiq.ai/guides/session-setup.md): POST /v1/personas/session — bind a seat's members and their ages for the session.
- [Personas](https://docs.westiq.ai/guides/personas.md): Generate a per-member entertainment persona, and list the airline's archetype gallery.
- [Catalog Serve](https://docs.westiq.ai/guides/catalog-serve.md): The age-gated catalog read — unscored (GET) and per-member scored (POST).
- [Catalog Ingestion](https://docs.westiq.ai/guides/catalog-ingest.md): Submit your media catalog in batches and poll the job for its outcome — the accept-then-poll ingestion surface.
- [Content Package v1](https://docs.westiq.ai/guides/content-package.md): A versioned title catalog with optional HTTPS artwork references.
- [Product Ingestion](https://docs.westiq.ai/guides/products-ingest.md): Submit your product catalog — duty-free, food & beverage, retail — in batches and poll the job for its outcome.
- [Flights & Active Catalog](https://docs.westiq.ai/guides/flights.md): Register a flight's operational context and the titles actually loaded on the aircraft — so a passenger is never shown something that isn't there.
- [Suggestions](https://docs.westiq.ai/guides/suggestions.md): POST /v1/suggestions — score a batch of titles for one member.
- [Enrichment](https://docs.westiq.ai/guides/enrichment.md): POST /v1/enrichment — deep per-member behavioral enrichment, on a trigger gate.
- [Session Events (SSE)](https://docs.westiq.ai/guides/session-events.md): Live server-sent events for a passenger session, with a poll/replay fallback.
- [Completed Update Delivery](https://docs.westiq.ai/guides/completed-delivery.md): Ordered completed updates, stable retries, and acknowledgements for one logical consumer.
- [Shopping Search](https://docs.westiq.ai/guides/shopping-search.md): POST /v1/shopping/search — natural-language product search, age-gated and member-aware.
- [Shopping Curate & Rescore](https://docs.westiq.ai/guides/shopping-curate.md): POST /v1/shopping/curate and POST /v1/shopping/rescore — sectioned, per-member shopping with code-owned pricing.
- [Ads Decisioning](https://docs.westiq.ai/guides/ads-decision.md): POST /v1/ads/decision — per-member, age-gated pre-roll ad selection. No pricing, no bidding.
- [Destination Search & Replace](https://docs.westiq.ai/guides/destination-search.md): POST /v1/destination/search and POST /v1/destination/replace — POI discovery for a destination, member-scored.
- [Destination Plan & Extend](https://docs.westiq.ai/guides/destination-plan.md): POST /v1/destination/plan and POST /v1/destination/extend — a per-member daily itinerary, code-dated.
- [Destination Weather](https://docs.westiq.ai/guides/destination-weather.md): POST /v1/destination/weather — a daily forecast for a destination, honestly degraded.
- [Hero Images](https://docs.westiq.ai/guides/hero-images.md): POST /v1/shopping/hero-image and POST /v1/destination/hero-image — attributed banner images from a shared image provider.
- [Errors & Limits](https://docs.westiq.ai/guides/errors.md): The ApiError envelope, error codes, correlation IDs, request limits, and rate limiting.
- [Security & Trust](https://docs.westiq.ai/security.md): How airline data is isolated, encrypted, and kept out of model training — stated as verifiable properties, not promises.
- [FAQ](https://docs.westiq.ai/help/faq.md): Common questions from WestIQ partners.

## API Docs

- API Reference > Health [Liveness probe](https://docs.westiq.ai/api-reference/api-reference/health/healthz.md)
- API Reference > Search [Natural-language catalog search](https://docs.westiq.ai/api-reference/api-reference/search/search-v-1.md)
- API Reference > Catalog [Unscored, age-gated catalog read](https://docs.westiq.ai/api-reference/api-reference/catalog/catalog-serve-v-1.md)
- API Reference > Catalog [Scored, per-member, age-gated catalog serve](https://docs.westiq.ai/api-reference/api-reference/catalog/catalog-serve-scored-v-1.md)
- API Reference > Catalog [Submit a batch of catalog titles for ingestion](https://docs.westiq.ai/api-reference/api-reference/catalog/catalog-ingest-jobs-v-1.md)
- API Reference > Catalog [Get the status of a catalog ingestion job](https://docs.westiq.ai/api-reference/api-reference/catalog/catalog-ingest-job-status-v-1.md)
- API Reference > Events [Ingest a batch of behavioral events](https://docs.westiq.ai/api-reference/api-reference/events/events-v-1.md)
- API Reference > Theme [Get the authenticated airline's theme](https://docs.westiq.ai/api-reference/api-reference/theme/theme-v-1.md)
- API Reference > Sessions [Server-sent events for one passenger session](https://docs.westiq.ai/api-reference/api-reference/sessions/session-stream-v-1.md)
- API Reference > Sessions [Poll/replay session-event frames after a cursor](https://docs.westiq.ai/api-reference/api-reference/sessions/session-state-v-1.md)
- API Reference > Personas [Generate a passenger entertainment persona (Deep tier)](https://docs.westiq.ai/api-reference/api-reference/personas/persona-generate-v-1.md)
- API Reference > Personas [List the airline's selectable persona archetypes](https://docs.westiq.ai/api-reference/api-reference/personas/persona-list-v-1.md)
- API Reference > Personas [Bind the session's seat-member roster](https://docs.westiq.ai/api-reference/api-reference/personas/persona-session-bind-v-1.md)
- API Reference > Enrichment [Deep-tier per-member behavioral enrichment](https://docs.westiq.ai/api-reference/api-reference/enrichment/enrichment-v-1.md)
- API Reference > Suggestions [Fast-tier, per-member content suggestions](https://docs.westiq.ai/api-reference/api-reference/suggestions/suggestions-v-1.md)
- API Reference > Shopping [Natural-language product search](https://docs.westiq.ai/api-reference/api-reference/shopping/product-search-v-1.md)
- API Reference > Shopping [Submit a batch of products for ingestion](https://docs.westiq.ai/api-reference/api-reference/shopping/product-ingest-jobs-v-1.md)
- API Reference > Shopping [Get the status of a product ingestion job](https://docs.westiq.ai/api-reference/api-reference/shopping/product-ingest-job-status-v-1.md)
- API Reference > Shopping [Resolve a themed hero image for a shopping subject](https://docs.westiq.ai/api-reference/api-reference/shopping/shopping-hero-image-v-1.md)
- API Reference > Shopping [Per-member shopping curation](https://docs.westiq.ai/api-reference/api-reference/shopping/shopping-curate-v-1.md)
- API Reference > Shopping [Light-touch re-score of currently-visible shopping products](https://docs.westiq.ai/api-reference/api-reference/shopping/shopping-rescore-v-1.md)
- API Reference > Ads [Fast-tier, per-member pre-roll ad decisioning](https://docs.westiq.ai/api-reference/api-reference/ads/ads-decision-v-1.md)
- API Reference > Flights [Register or replace a flight's operational context](https://docs.westiq.ai/api-reference/api-reference/flights/flight-context-write-v-1.md)
- API Reference > Flights [Replace a flight's active catalog by external id](https://docs.westiq.ai/api-reference/api-reference/flights/flight-active-catalog-write-v-1.md)
- API Reference > Destination [Generate a multi-day destination itinerary](https://docs.westiq.ai/api-reference/api-reference/destination/destination-plan-v-1.md)
- API Reference > Destination [Extend an existing destination itinerary with additional days](https://docs.westiq.ai/api-reference/api-reference/destination/destination-extend-v-1.md)
- API Reference > Destination [Fast-tier, single-slot POI replacement](https://docs.westiq.ai/api-reference/api-reference/destination/destination-replace-v-1.md)
- API Reference > Destination [Fast-tier, per-member POI curation (dining + experiences)](https://docs.westiq.ai/api-reference/api-reference/destination/destination-search-v-1.md)
- API Reference > Destination [Get a destination forecast](https://docs.westiq.ai/api-reference/api-reference/destination/destination-weather-v-1.md)
- API Reference > Destination [Get a destination hero image](https://docs.westiq.ai/api-reference/api-reference/destination/destination-hero-image-v-1.md)
- API Reference > Authentication [Exchange client credentials for an access token](https://docs.westiq.ai/api-reference/api-reference/authentication/get-access-token.md)
- API Reference > Completed Delivery [Find an available delivery slot](https://docs.westiq.ai/api-reference/api-reference/completed-delivery/delivery-discover-v-1.md)
- API Reference > Completed Delivery [Open a bounded delivery lease](https://docs.westiq.ai/api-reference/api-reference/completed-delivery/delivery-open-v-1.md)
- API Reference > Completed Delivery [Look up the owned delivery lease](https://docs.westiq.ai/api-reference/api-reference/completed-delivery/delivery-lookup-v-1.md)
- API Reference > Completed Delivery [Commit a completed update with a stable identity](https://docs.westiq.ai/api-reference/api-reference/completed-delivery/delivery-append-v-1.md)
- API Reference > Completed Delivery [Find an available read receipt cell](https://docs.westiq.ai/api-reference/api-reference/completed-delivery/delivery-receipt-slot-v-1.md)
- API Reference > Completed Delivery [Read a contiguous page of completed updates](https://docs.westiq.ai/api-reference/api-reference/completed-delivery/delivery-read-v-1.md)
- API Reference > Completed Delivery [Acknowledge an applied contiguous update range](https://docs.westiq.ai/api-reference/api-reference/completed-delivery/delivery-ack-v-1.md)
- API Reference > Completed Delivery [Close a delivery lease](https://docs.westiq.ai/api-reference/api-reference/completed-delivery/delivery-close-v-1.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.westiq.ai/openapi.json)
- [OpenAPI YAML](https://docs.westiq.ai/openapi.yaml)