{"openapi":"3.1.0","info":{"title":"Airbnb API (Bowmark)","version":"186fdf3b86f9","description":"Airbnb's own stays search — a location, optional dates and guest counts in, priced listing rows (title, rating, review count, display price, photo, url) out, straight off airbnb.com/s — plus one known listing's full details (description, amenities, house rules, rating breakdown, host, photos), its guest reviews, its price quote with every fee line for given dates, its availability calendar, a host's profile and listings, and a place's experiences.\n\nEvery function Bowmark has for Airbnb (airbnb.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/airbnb/getHostProfile":{"post":{"operationId":"getHostProfile","summary":"Get host info for an Airbnb listing: a vacation rental host's public Airbnb profile (airbnb.com/users/show/<id>): name, about text, where they live, Superhost and identity-verified badges, years hosti","description":"Get host info for an Airbnb listing: a vacation rental host's public Airbnb profile (airbnb.com/users/show/<id>): name, about text, where they live, Superhost and identity-verified badges, years hosting, overall rating and review count, languages, how many properties they host with the first page of those listings (title, type, beds, rating, url) and recent guest reviews. Pass the `hostId` (`getListingDetails().host.id` returns it), the profile `url`, or a `listing` url or id to look up whoever hosts that rental.\n\nCalls `bowmark.providers.airbnb.getHostProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AirbnbHostProfile>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"hostId":{"type":"string"},"url":{"type":"string"},"listing":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ hostId?: string, url?: string, listing?: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/airbnb/getListingDetails":{"post":{"operationId":"getListingDetails","summary":"Everything the Airbnb listing page (airbnb.com/rooms/<id>) shows about one vacation rental or short-term stay, no dates needed: title, property type, full description, how many guests, bedrooms, beds ","description":"Everything the Airbnb listing page (airbnb.com/rooms/<id>) shows about one vacation rental or short-term stay, no dates needed: title, property type, full description, how many guests, bedrooms, beds and bathrooms it has, star rating with the six category ratings (cleanliness, accuracy, check-in, communication, location, value) and the star distribution, highlights, every amenity grouped and flagged available or not (wifi, kitchen, parking, pool), where each guest sleeps, house rules (pets, smoking, quiet hours), safety notes, location (area, coordinates, region breadcrumbs, nearby cities to browse), the host summary (id, Superhost, response rate and time, co-hosts) and the photo tour. Pass the `/rooms/<id>` `url` or the `id` that `search` returns.\n\nCalls `bowmark.providers.airbnb.getListingDetails`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AirbnbListingDetails>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"url":{"type":"string"},"id":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ url?: string, id?: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/airbnb/getListingReviews":{"post":{"operationId":"getListingReviews","summary":"Guest reviews of one Airbnb vacation rental, read from the listing page's own reviews panel: each with star rating, date, full text, reviewer first name and home town, the stay note (\"Stayed a few nig","description":"Guest reviews of one Airbnb vacation rental, read from the listing page's own reviews panel: each with star rating, date, full text, reviewer first name and home town, the stay note (\"Stayed a few nights\") and any host reply, plus the listing's total review count and the topics guests mention most (Location 124, Cleanliness 55). `sort` is mostRecent (default), highestRated, lowestRated or bestQuality; page with `limit` (1-50, default 10) and the `nextOffset` the last result returned.\n\nCalls `bowmark.providers.airbnb.getListingReviews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AirbnbListingReviews>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"url":{"type":"string"},"id":{"type":"string"},"sort":{"anyOf":[{"const":"mostRecent"},{"const":"highestRated"},{"const":"lowestRated"},{"const":"bestQuality"}]},"limit":{"type":"number"},"offset":{"type":"number"}},"additionalProperties":true,"description":"TypeScript: `{ url?: string, id?: string, sort?: \"mostRecent\" | \"highestRated\" | \"lowestRated\" | \"bestQuality\", limit?: number, offset?: number }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/airbnb/getPriceQuote":{"post":{"operationId":"getPriceQuote","summary":"The total price of staying at one Airbnb vacation rental for given dates, with every line the booking panel shows (nightly rate times nights, cleaning fee, service fee and any discount where the host ","description":"The total price of staying at one Airbnb vacation rental for given dates, with every line the booking panel shows (nightly rate times nights, cleaning fee, service fee and any discount where the host charges them), whether those dates can be booked at all and, when they cannot, the site's reason (minimum stay, already booked). The total is the site's own 'before taxes' figure; taxes are added only at checkout. `checkin`/`checkout` are YYYY-MM-DD and both required; `adults` default 1, `currency` an ISO code (default USD). Nothing is reserved or charged. Same panel as getListing, without the day-by-day calendar.\n\nCalls `bowmark.providers.airbnb.getPriceQuote`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AirbnbListingAvailability>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"url":{"type":"string"},"id":{"type":"string"},"checkin":{"type":"string"},"checkout":{"type":"string"},"adults":{"type":"number"},"currency":{"type":"string"}},"required":["checkin","checkout"],"additionalProperties":true,"description":"TypeScript: `{ url?: string, id?: string, checkin: string, checkout: string, adults?: number, currency?: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/airbnb/bookListing":{"post":{"operationId":"bookListing","summary":"Reserve or book an Airbnb stay: returns the checkout link, never books or pays.","description":"Reserve or book an Airbnb stay: returns the checkout link, never books or pays. Pass the listing `url` (airbnb.com/rooms/<id>) or `id`, `checkin`/`checkout` (`YYYY-MM-DD`), `adults` (default 1) and `currency` (default USD). When the dates can be booked it returns `ready_to_checkout`: a /rooms link carrying the dates and guests, the Airbnb account to be signed in as, and the booking panel's total before taxes. When they cannot (booked, minimum stay) it returns `unavailable` with the site's own reason. The person opens the link, signs in and presses Airbnb's own Reserve button; taxes shown at Airbnb's checkout are the price of record.\n\nCalls `bowmark.providers.airbnb.bookListing`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AirbnbCheckoutHandoff>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"url":{"type":"string"},"id":{"type":"string"},"checkin":{"type":"string"},"checkout":{"type":"string"},"adults":{"type":"number"},"currency":{"type":"string"}},"required":["checkin","checkout"],"additionalProperties":true,"description":"TypeScript: `{ url?: string, id?: string, checkin: string, checkout: string, adults?: number, currency?: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/airbnb/searchExperiences":{"post":{"operationId":"searchExperiences","summary":"Tours, classes and things to do (Airbnb Experiences: guided walks, cooking classes, activities) for a city, from the place's own things-to-do page: title, category (Cultural tours, Cooking classes), c","description":"Tours, classes and things to do (Airbnb Experiences: guided walks, cooking classes, activities) for a city, from the place's own things-to-do page: title, category (Cultural tours, Cooking classes), city, blurb, star rating, review count, photo and the experience url, grouped by the page's shelves such as \"Top-rated activities\". `location` is free text like \"Montreal\", \"Lisbon, Portugal\" or \"Austin, Texas\".\n\nCalls `bowmark.providers.airbnb.searchExperiences`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AirbnbExperience[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"location":{"type":"string"}},"required":["location"],"additionalProperties":true,"description":"TypeScript: `{ location: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/airbnb/search":{"post":{"operationId":"search","summary":"Search vacation rentals and short-term stays (homes, apartments, cabins, rooms) on Airbnb for a free-text `location` (e.g.","description":"Search vacation rentals and short-term stays (homes, apartments, cabins, rooms) on Airbnb for a free-text `location` (e.g. \"San Francisco\", \"Austin, Texas\"), the way airbnb.com/s does: optional `checkin`/`checkout` (`YYYY-MM-DD`), guest counts (`adults`, `children`, `infants`, `pets`) and filters (`minPrice`/`maxPrice` per night in the site's currency, `roomType`, `minBedrooms`, `minBeds`, `minBathrooms`); `page` (1-15, default 1) walks the results 18 at a time. Returns each place's title, subtitle, star rating, review count, the site's own display price string, cover photo and `/rooms/<id>` url.\n\nCalls `bowmark.providers.airbnb.search`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AirbnbListing[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"location":{"type":"string"},"checkin":{"type":"string"},"checkout":{"type":"string"},"adults":{"type":"number"},"children":{"type":"number"},"infants":{"type":"number"},"pets":{"type":"number"},"minPrice":{"type":"number"},"maxPrice":{"type":"number"},"roomType":{"anyOf":[{"const":"entire_home"},{"const":"private_room"},{"const":"shared_room"},{"const":"hotel_room"}]},"minBedrooms":{"type":"number"},"minBeds":{"type":"number"},"minBathrooms":{"type":"number"},"page":{"type":"number"}},"required":["location"],"additionalProperties":true,"description":"TypeScript: `{ location: string, checkin?: string, checkout?: string, adults?: number, children?: number, infants?: number, pets?: number, minPrice?: number, maxPrice?: number, roomType?: \"entire_home\" | \"private_room\" | \"shared_room\" | \"hotel_room\", minBedrooms?: number, minBeds?: number, minBathrooms?: number, page?: number }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/airbnb/getListing":{"post":{"operationId":"getListing","summary":"Check the availability calendar for one Airbnb listing: is the vacation rental available for given dates, and what does it cost per night: pass its `/rooms/<id>` url (or the `id` that `search` returns","description":"Check the availability calendar for one Airbnb listing: is the vacation rental available for given dates, and what does it cost per night: pass its `/rooms/<id>` url (or the `id` that `search` returns). With `checkin`/`checkout` (`YYYY-MM-DD`) it returns the booking panel's own quote (total, pre-discount total, nights, the per-night rate, discount lines) or the site's reason the dates cannot be booked; either way it returns the listing's day-by-day open/blocked availability calendar with minimum and maximum stay, `months` long (default 2) from the check-in month. `currency` is an ISO code, default USD.\n\nCalls `bowmark.providers.airbnb.getListing`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AirbnbListingAvailability>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"url":{"type":"string"},"id":{"type":"string"},"checkin":{"type":"string"},"checkout":{"type":"string"},"adults":{"type":"number"},"months":{"type":"number"},"currency":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ url?: string, id?: string, checkin?: string, checkout?: string, adults?: number, months?: number, currency?: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/airbnb/getListingCalendar":{"post":{"operationId":"getListingCalendar","summary":"The availability calendar for one Airbnb vacation rental listing, day by day: which nights are open or blocked, whether a guest can check in or out that day, the minimum and maximum stay, and the nigh","description":"The availability calendar for one Airbnb vacation rental listing, day by day: which nights are open or blocked, whether a guest can check in or out that day, the minimum and maximum stay, and the nightly price where the site shows it. Nothing else (no quote, no page copy), so it is the cheap call for \"is this listing free on these dates\". Pass its `/rooms/<id>` `url` or the `id` that `search` returns; `months` is how many months to read (default 2) starting at the month of `from` (`YYYY-MM-DD`, default today). `currency` is an ISO code, default USD.\n\nCalls `bowmark.providers.airbnb.getListingCalendar`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AirbnbListingCalendar>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"url":{"type":"string"},"id":{"type":"string"},"months":{"type":"number"},"from":{"type":"string"},"currency":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ url?: string, id?: string, months?: number, from?: string, currency?: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/airbnb/listTrips":{"post":{"operationId":"listTrips","summary":"SIGNED IN — the caller's own Airbnb trips from their Trips tab: upcoming, past and cancelled, newest first, each with the site's status word, `cancelled` and `upcoming` flags, dates, cover photo and t","description":"SIGNED IN — the caller's own Airbnb trips from their Trips tab: upcoming, past and cancelled, newest first, each with the site's status word, `cancelled` and `upcoming` flags, dates, cover photo and the trip's own page. `limit` caps each of the three lists (1-100, default 40). Runs through the caller's own Chrome when Bowmark Buddy is attached, otherwise from a saved Airbnb sign-in; with neither, the run pauses for the caller to sign in. No trips is `{ trips: [] }`.\n\nCalls `bowmark.providers.airbnb.listTrips`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AirbnbTrips>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"limit":{"type":"number"}},"additionalProperties":true,"description":"TypeScript: `{ limit?: number }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}}}}}