> ## Documentation Index
> Fetch the complete documentation index at: https://getanyapi.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Vrbo Search

> Search Vrbo vacation rentals by destination and dates, with guest, bedroom, bed, bathroom and price filters, and get up to 50 listings per call: Vrbo property ID and link, name, summary line, property type, bedrooms, beds, guest rating and review count, nightly and total stay price with the original nightly price before any discount, and photos as normalized JSON. Page with offset; the price is the same whatever the limit.

**Price:** \$1.00 per 1,000 requests (flat per request - same cost regardless of results returned).

**Routing:** one lane serves this API today, so a failed attempt has nowhere to fail over to. Payment outcome follows the selected rail's settlement policy.

**Catalog:** [Vrbo Search pricing and uptime](https://getanyapi.com/api/vrbo/search) - live USD price, lane routing, and measured 30-day uptime. [Every Vrbo endpoint](https://getanyapi.com/api/vrbo).



## OpenAPI

````yaml /openapi.json post /v1/run/vrbo.search
openapi: 3.1.0
info:
  contact:
    email: support@getanyapi.com
  description: >-
    Any API, one wallet, USD, no subscriptions. Each API is a single discovered
    operation: send the normalized input, get a normalized result. Prices and
    payment outcomes are reported in USD; each operation documents the
    settlement policy for its enabled payment rails.
  title: AnyAPI
  version: 1.0.0
  x-guidance: >-
    Use each operation's published method and path with its normalized JSON
    input (see the operation requestBody). Before setting a client or tool
    timeout, GET /v1/apis/{sku} and inspect its trailing-30-day latency
    p50/p95/p99 and sample; p99 is an observation, not a maximum. To pay: send
    your AnyAPI key (Authorization: Bearer, billed from your USD wallet). For
    operations that advertise an inline rail, pay per call inline with x402 -
    call with no key, receive HTTP 402 with a PAYMENT-REQUIRED header, then
    retry with the PAYMENT-SIGNATURE header (base, no account needed); or pay
    per call inline with MPP (Machine Payments Protocol) - call with no key,
    receive HTTP 402 with a WWW-Authenticate: Payment challenge, then retry with
    the Authorization: Payment header (tempo, no account needed). x402 settles
    after execution; execution failure is reported as released; mpp settles
    before execution; execution failure is reported as charged_undelivered.
servers:
  - url: https://api.getanyapi.com
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: ahrefs
    x-group: Ahrefs
  - name: airbnb
    x-group: Airbnb
  - name: alibaba
    x-group: Alibaba
  - name: aliexpress
    x-group: Aliexpress
  - name: amazon
    x-group: Amazon
  - name: apollo
    x-group: Apollo
  - name: appstore
    x-group: Appstore
  - name: asos
    x-group: Asos
  - name: bestbuy
    x-group: Bestbuy
  - name: bing
    x-group: Bing
  - name: bluesky
    x-group: Bluesky
  - name: booking
    x-group: Booking
  - name: brave
    x-group: Brave
  - name: capterra
    x-group: Capterra
  - name: chatgpt
    x-group: Chatgpt
  - name: coinmarketcap
    x-group: Coinmarketcap
  - name: company
    x-group: Company
  - name: company-enrichment
    x-group: Company_enrichment
  - name: company-identify
    x-group: Company_identify
  - name: company-search
    x-group: Company_search
  - name: congress
    x-group: Congress
  - name: contact-enrichment
    x-group: Contact_enrichment
  - name: douyin
    x-group: Douyin
  - name: duckduckgo
    x-group: Duckduckgo
  - name: ebay
    x-group: Ebay
  - name: email
    x-group: Email
  - name: email-finding
    x-group: Email_finding
  - name: email-verification
    x-group: Email_verification
  - name: etsy
    x-group: Etsy
  - name: facebook
    x-group: Facebook
  - name: fiverr
    x-group: Fiverr
  - name: g2
    x-group: G2
  - name: gemini
    x-group: Gemini
  - name: github
    x-group: Github
  - name: glassdoor
    x-group: Glassdoor
  - name: google
    x-group: Google
  - name: google-ads
    x-group: Google Ads
  - name: google-finance
    x-group: Google Finance
  - name: google-flights
    x-group: Google_flights
  - name: google-hotels
    x-group: Google Hotels
  - name: google-shopping
    x-group: Google Shopping
  - name: hackernews
    x-group: Hackernews
  - name: ikea
    x-group: Ikea
  - name: indeed
    x-group: Indeed
  - name: instagram
    x-group: Instagram
  - name: job-search
    x-group: Job_search
  - name: levels
    x-group: Levels
  - name: linkedin
    x-group: Linkedin
  - name: linktree
    x-group: Linktree
  - name: maps
    x-group: Maps
  - name: mobile-phone
    x-group: Mobile_phone
  - name: naver
    x-group: Naver
  - name: nextdoor
    x-group: Nextdoor
  - name: people-search
    x-group: People_search
  - name: perplexity
    x-group: Perplexity
  - name: person
    x-group: Person
  - name: person-enrichment
    x-group: Person_enrichment
  - name: pexels
    x-group: Pexels
  - name: pinterest
    x-group: Pinterest
  - name: playstore
    x-group: Playstore
  - name: polymarket
    x-group: Polymarket
  - name: property-records
    x-group: Property_records
  - name: realtor
    x-group: Realtor
  - name: reddit
    x-group: Reddit
  - name: redfin
    x-group: Redfin
  - name: rednote
    x-group: Rednote
  - name: samsclub
    x-group: Samsclub
  - name: sec
    x-group: Sec
  - name: semrush
    x-group: Semrush
  - name: seo
    x-group: Seo
  - name: shopify
    x-group: Shopify
  - name: similarweb
    x-group: Similarweb
  - name: slickdeals
    x-group: Slickdeals
  - name: snapchat
    x-group: Snapchat
  - name: social
    x-group: Social
  - name: spotify
    x-group: Spotify
  - name: substack
    x-group: Substack
  - name: target
    x-group: Target
  - name: technographics
    x-group: Technographics
  - name: telegram
    x-group: Telegram
  - name: threads
    x-group: Threads
  - name: tiktok
    x-group: TikTok
  - name: tiktok-shop
    x-group: TikTok Shop
  - name: tripadvisor
    x-group: Tripadvisor
  - name: trustpilot
    x-group: Trustpilot
  - name: truthsocial
    x-group: Truthsocial
  - name: twitter
    x-group: X (Twitter)
  - name: unsplash
    x-group: Unsplash
  - name: upwork
    x-group: Upwork
  - name: vrbo
    x-group: Vrbo
  - name: walmart
    x-group: Walmart
  - name: web
    x-group: Web
  - name: weibo
    x-group: Weibo
  - name: yahoo-finance
    x-group: Yahoo Finance
  - name: yelp
    x-group: Yelp
  - name: youtube
    x-group: YouTube
  - name: zhihu
    x-group: Zhihu
  - name: zillow
    x-group: Zillow
paths:
  /v1/run/vrbo.search:
    post:
      tags:
        - vrbo
      summary: Vrbo Search
      description: >-
        Search Vrbo vacation rentals by destination and dates, with guest,
        bedroom, bed, bathroom and price filters, and get up to 50 listings per
        call: Vrbo property ID and link, name, summary line, property type,
        bedrooms, beds, guest rating and review count, nightly and total stay
        price with the original nightly price before any discount, and photos as
        normalized JSON. Page with offset; the price is the same whatever the
        limit.


        **Price:** \$1.00 per 1,000 requests (flat per request - same cost
        regardless of results returned).


        **Routing:** one lane serves this API today, so a failed attempt has
        nowhere to fail over to. Payment outcome follows the selected rail's
        settlement policy.


        **Catalog:** [Vrbo Search pricing and
        uptime](https://getanyapi.com/api/vrbo/search) - live USD price, lane
        routing, and measured 30-day uptime. [Every Vrbo
        endpoint](https://getanyapi.com/api/vrbo).
      operationId: vrbo_search
      parameters:
        - description: >-
            Optional. Comma-separated keys (dotted paths like `author.name`
            descend into nested objects) to keep on each result item: each row
            of the API's result list, or the `data` object itself for an API
            that returns one record. Keys are matched relative to that item, not
            against the top-level response envelope, so use `jq` to reshape the
            whole envelope. Shrinks the response without changing cost.
          in: query
          name: fields
          required: false
          schema:
            type: string
        - description: >-
            Optional. Cap the number of result rows returned; a `_truncated`
            note reports how many were withheld so you can page via the API's
            own `limit`. An API that returns one record is not trimmed. Does not
            change cost.
          in: query
          name: max_items
          required: false
          schema:
            minimum: 0
            type: integer
        - description: >-
            Optional. Return only a structural outline (top-level keys, item
            counts, and per-field byte sizes) instead of the full data. Does not
            change cost.
          in: query
          name: summary
          required: false
          schema:
            type: boolean
        - description: >-
            Optional. A jq expression applied to the result envelope; its output
            replaces `output` (multiple outputs collect into an array). Reshape
            freely, e.g. `jq=.data | {title, description, md:
            .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on
            failure the full result is returned with a `jqError`. Does not
            change cost.
          in: query
          name: jq
          required: false
          schema:
            type: string
        - description: >-
            Optional. The most you are willing to pay for this one request, in
            US dollars (for example 0.05). Any route that would charge more than
            this is not used, so a request only ever runs on something you can
            afford. If nothing is available at or below your amount, the request
            is refused before it runs, nothing is charged, and the message tells
            you the cheapest price per request so you can raise it. Leave it out
            to accept the normal price.
          in: query
          name: max_cost_usd
          required: false
          schema:
            type: string
        - description: >-
            Optional wallet idempotency key, scoped to this customer for 24
            hours. When the gateway honors the key, this synchronous in-process
            execution can continue after the caller disconnects, bounded by its
            execution deadline. A completed replayable result charges normally
            exactly once and can be replayed without another provider run or
            charge. A pending duplicate returns 409 idempotency_in_progress;
            reuse with different request semantics returns 409
            idempotency_conflict.
          in: header
          name: Idempotency-Key
          required: false
          schema:
            maxLength: 255
            minLength: 1
            type: string
      requestBody:
        content:
          application/json:
            example:
              adults: 2
              checkIn: '2026-12-04'
              checkOut: '2026-12-07'
              limit: 5
              location: Lake Tahoe
            schema:
              additionalProperties: false
              example:
                adults: 2
                checkIn: '2026-12-04'
                checkOut: '2026-12-07'
                limit: 5
                location: Lake Tahoe
              properties:
                adults:
                  description: Number of adult guests (e.g. 2).
                  maximum: 20
                  minimum: 1
                  type: integer
                allowFallbacks:
                  default: true
                  description: >-
                    Optional, default true. When false, only the sources listed
                    in `source` may serve; the request is refused with no charge
                    if none of them can. When true, the listed sources are tried
                    first and any other source may serve after them, at the
                    normal price.
                  type: boolean
                checkIn:
                  description: >-
                    Check-in date in YYYY-MM-DD format (e.g. 2027-01-15). Today
                    or later.
                  format: date
                  pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
                  type: string
                checkOut:
                  description: >-
                    Check-out date in YYYY-MM-DD format (e.g. 2027-01-18). After
                    the check-in date.
                  format: date
                  pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
                  type: string
                childrenAges:
                  description: >-
                    Age of each child guest, one entry per child (e.g. [5, 8]
                    for two children aged 5 and 8). Omit it when no children are
                    staying.
                  items:
                    maximum: 17
                    minimum: 0
                    type: integer
                  maxItems: 8
                  minItems: 1
                  type: array
                ignoreSources:
                  description: >-
                    Optional. Source ids to skip for this request, taken from
                    this endpoint's `lanes[].source.id`. The cheapest remaining
                    source serves and the price is that of the dearest remaining
                    source. An id that does not serve this endpoint, or that is
                    also in `source`, is rejected as invalid input with no
                    charge; skipping every source is rejected the same way.
                  items:
                    minLength: 1
                    type: string
                  type: array
                  uniqueItems: true
                limit:
                  default: 20
                  description: >-
                    Maximum number of listings to return (1-50, default 20). The
                    price is the same whatever the limit.
                  maximum: 50
                  minimum: 1
                  type: integer
                location:
                  description: >-
                    Destination to search rentals in: a city, region or area
                    (e.g. Lake Tahoe, Lisbon, Outer Banks, North Carolina).
                  maxLength: 120
                  minLength: 2
                  type: string
                minBathrooms:
                  description: Minimum number of bathrooms (e.g. 2).
                  maximum: 50
                  minimum: 1
                  type: integer
                minBedrooms:
                  description: Minimum number of bedrooms (e.g. 3).
                  maximum: 50
                  minimum: 0
                  type: integer
                minBeds:
                  description: Minimum number of beds (e.g. 4).
                  maximum: 20
                  minimum: 1
                  type: integer
                offset:
                  default: 0
                  description: >-
                    Number of listings to skip, for paging: send offset 20 with
                    limit 20 for the second page.
                  maximum: 1000
                  minimum: 0
                  type: integer
                preferLatencyUnderMs:
                  description: >-
                    Optional; omit it and routing is unchanged, with the
                    cheapest source serving. Prefer sources whose typical
                    response time (median over the trailing 30 days, as
                    published on this endpoint's lane health) is under this many
                    milliseconds; among those, the cheapest serves. This can
                    raise your price: when the cheapest source misses the
                    target, a faster and dearer one serves, and you are quoted
                    and charged its price. If no source is that fast the request
                    is still served, by whichever source offers the best speed
                    for its price - it is never refused for being slow. Sources
                    we have not timed are tried last. This is a preference, not
                    a guarantee: the median describes past requests and is not a
                    ceiling on this one, and it excludes any wait this request
                    itself asks for. On a paginated walk it applies to the first
                    page only: later pages stay with the source that page chose,
                    at the price it was quoted.
                  minimum: 1
                  type: integer
                priceMax:
                  description: >-
                    Maximum price in the currency results are priced in (each
                    listing's currency), per night or for the whole stay as
                    priceType says (e.g. 400). With a price filter, only
                    listings Vrbo prices for your dates are returned.
                  maximum: 1000000
                  minimum: 1
                  type: integer
                priceMin:
                  description: >-
                    Minimum price in the currency results are priced in (each
                    listing's currency), per night or for the whole stay as
                    priceType says (e.g. 100).
                  maximum: 1000000
                  minimum: 0
                  type: integer
                priceType:
                  default: nightly
                  description: >-
                    Whether priceMin and priceMax are a nightly price (default)
                    or the total for the stay.
                  enum:
                    - nightly
                    - total
                  type: string
                sort:
                  description: >-
                    Result order: recommended (Vrbo's default),
                    price_low_to_high, price_high_to_low, review (highest rated
                    first) or review_count (most reviewed first).
                  enum:
                    - recommended
                    - price_low_to_high
                    - price_high_to_low
                    - review
                    - review_count
                  type: string
                source:
                  description: >-
                    Optional. Source ids to prefer, in order, taken from this
                    endpoint's `lanes[].source.id` in /catalog or /apis. Omit it
                    and the cheapest source serves, with automatic failover.
                    Listed sources are tried first in the order given, then the
                    others, unless `allowFallbacks` is false. A single source
                    with `allowFallbacks` false is served only by that source at
                    its price, quoted and charged exactly, with no failover. The
                    price is that of the dearest source that may serve. An id
                    that does not serve this endpoint is rejected as invalid
                    input with no charge; a listed source that is not serving
                    right now is refused with no charge, so omit `source` to be
                    served by another. On a paginated walk, later pages must
                    include the source that served page one, or omit `source`.
                  items:
                    minLength: 1
                    type: string
                  type: array
                  uniqueItems: true
              required:
                - location
                - checkIn
                - checkOut
              title: Vrbo search input
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  costUsd:
                    description: >-
                      USD charged on the original run. On a replay this value is
                      echoed for parity; the replay itself is free.
                    type: number
                  hint:
                    description: >-
                      Optional one-line nudge, absent when there is nothing to
                      say. `large_result:` suggests the
                      fields/max_items/summary/jq controls for a big response.
                      `paging_unavailable:` means this result came from a source
                      that cannot return a `nextCursor`, so it may be INCOMPLETE
                      and cannot be continued - re-run with `requireFields:
                      ["nextCursor"]` to be served only by a source that can
                      page, which may cost more per request. `malformed_query:`
                      means X read your search query differently than it looks
                      (adjacent bare words are ANDed and OR binds tighter, so a
                      multi-word alternative is not a phrase, and an operator
                      after an unbracketed OR list applies to its last
                      alternative only); the run was served and billed as X read
                      it, and the hint carries the corrected query to send
                      instead. `date_adjusted:` means a date you sent was
                      outside the range the platform accepts, so the run used
                      the nearest accepted date the hint names.
                    type: string
                  items:
                    description: >-
                      Number of result rows returned; an API that returns one
                      record counts it as one row. For per-result APIs the
                      per-item cost is charged against this count; for
                      input-priced APIs the charge is per submitted input,
                      independent of this count.
                    type: integer
                  jqError:
                    description: >-
                      Present only when a `jq` expression failed; `output` then
                      carries the full unshaped result and this explains why the
                      reshape did not apply.
                    type: string
                  output:
                    anyOf:
                      - additionalProperties: false
                        properties:
                          data:
                            description: Result payload, or null when nothing was found.
                            oneOf:
                              - type: 'null'
                              - additionalProperties: false
                                properties:
                                  items:
                                    description: >-
                                      Vrbo listings priced for the requested
                                      dates and guests, in Vrbo's order. A
                                      listing Vrbo shows without a price for the
                                      dates is left out. Populated whenever the
                                      provider has data for the entity.
                                    items:
                                      properties:
                                        bedrooms:
                                          description: >-
                                            Number of bedrooms. Populated whenever
                                            the provider has data for the entity.
                                          type:
                                            - integer
                                            - 'null'
                                          x-anyapi-must-populate: true
                                        beds:
                                          description: >-
                                            Number of beds. Populated whenever the
                                            provider has data for the entity.
                                          type:
                                            - integer
                                            - 'null'
                                          x-anyapi-must-populate: true
                                        currency:
                                          description: >-
                                            ISO 4217 currency code of the prices
                                            (e.g. USD). Populated whenever the
                                            provider has data for the entity.
                                          type:
                                            - string
                                            - 'null'
                                          x-anyapi-must-populate: true
                                        feesNote:
                                          description: >-
                                            Vrbo's note on what the price includes
                                            (e.g. All fees included).
                                          type:
                                            - string
                                            - 'null'
                                        id:
                                          description: Vrbo property ID.
                                          type: string
                                        images:
                                          description: >-
                                            Listing photo URLs. Populated whenever
                                            the provider has data for the entity.
                                          items:
                                            type: string
                                          type:
                                            - array
                                            - 'null'
                                          x-anyapi-must-populate: true
                                        name:
                                          description: >-
                                            Listing name. Vrbo often shows a generic
                                            name such as "Condo in Kings Beach".
                                          type: string
                                        nights:
                                          description: Number of nights the total price covers.
                                          type:
                                            - integer
                                            - 'null'
                                        originalPricePerNight:
                                          description: >-
                                            Nightly price before Vrbo's discount, or
                                            null when the listing is not discounted.
                                          type:
                                            - number
                                            - 'null'
                                        overview:
                                          description: >-
                                            Vrbo's one-line summary of the listing
                                            (e.g. "3 bedrooms · 6 beds · Free
                                            cancellation until Dec 16"). Populated
                                            whenever the provider has data for the
                                            entity.
                                          type:
                                            - string
                                            - 'null'
                                          x-anyapi-must-populate: true
                                        pricePerNight:
                                          description: >-
                                            Nightly price for the requested dates
                                            and guests, in currency. Populated
                                            whenever the provider has data for the
                                            entity.
                                          type:
                                            - number
                                            - 'null'
                                          x-anyapi-must-populate: true
                                        propertyType:
                                          description: >-
                                            Property type (e.g. Condo, House), or
                                            null when Vrbo does not state it in
                                            search results.
                                          type:
                                            - string
                                            - 'null'
                                        rating:
                                          description: >-
                                            Average guest rating out of 10, or null
                                            when the listing has no rating.
                                            Populated whenever the provider has data
                                            for the entity.
                                          type:
                                            - number
                                            - 'null'
                                          x-anyapi-must-populate: true
                                        ratingLabel:
                                          description: >-
                                            Vrbo's word for the rating (e.g.
                                            Exceptional, Wonderful).
                                          type:
                                            - string
                                            - 'null'
                                        reviewsCount:
                                          description: >-
                                            Number of guest reviews, or null when
                                            Vrbo does not show a count.
                                          type:
                                            - integer
                                            - 'null'
                                        totalPrice:
                                          description: >-
                                            Total price for the whole stay, in
                                            currency. Populated whenever the
                                            provider has data for the entity.
                                          type:
                                            - number
                                            - 'null'
                                          x-anyapi-must-populate: true
                                        url:
                                          description: Vrbo listing URL.
                                          type: string
                                      required:
                                        - id
                                        - url
                                        - name
                                      type: object
                                    type: array
                                    x-anyapi-must-populate: true
                                required:
                                  - items
                                type: object
                          found:
                            description: Whether any priced listings were found.
                            type: boolean
                          reason:
                            description: >-
                              Present only when `found` is false, and says why
                              there is no result. `not_found`: the source states
                              the target does not exist, or returned nothing for
                              it. A `found: false` answer is a successful call,
                              not an error, and `costUsd` is what it actually
                              cost.
                            enum:
                              - not_found
                            type: string
                        required:
                          - found
                          - data
                        title: Vrbo search output
                        type: object
                      - type: 'null'
                    description: >-
                      Normalized output, or null when the replay payload was not
                      retained.
                  provider:
                    description: Always "AnyAPI".
                    type: string
                  replayed:
                    description: >-
                      True when this response replays the durable result of an
                      earlier run without billing or upstream execution.
                    type: boolean
                  resultId:
                    description: >-
                      Opaque handle to the full unshaped result, cached ~15 min.
                      Re-shape it for free (fields/max_items/summary/jq) via GET
                      /v1/results/{id}, no re-billing. Absent when the result
                      was too large to cache.
                    type: string
                  source:
                    description: >-
                      The source that served this run. Pass its `id` back as
                      `source` to prefer it again, or as `ignoreSources` to
                      avoid it. Absent when no source identity applies to the
                      run.
                    properties:
                      artworkKey:
                        description: Key for this source's artwork.
                        type: string
                      id:
                        description: Stable identifier for this source.
                        type: string
                      kind:
                        description: >-
                          anonymous is a stable identity for an unattributed
                          source; brand names the dataset that supplies the
                          data.
                        enum:
                          - anonymous
                          - brand
                        type: string
                      name:
                        description: Display name for this source.
                        type: string
                    required:
                      - id
                      - name
                      - kind
                      - artworkKey
                    type: object
                required:
                  - output
                  - provider
                  - costUsd
                  - items
                  - replayed
                type: object
          description: Normalized result.
          headers:
            Idempotency-Replayed:
              description: >-
                Present only when the request carried an Idempotency-Key this
                gateway honored. "false" means the key was claimed and the run
                executed freshly; "true" means it replayed a prior identical run
                and was NOT charged again. Absent means either no key was sent
                or this gateway does not honor keys, so a retry could be charged
                twice.
              schema:
                enum:
                  - 'false'
                  - 'true'
                type: string
            PAYMENT-RESPONSE:
              description: Inline x402 payment receipt.
              schema:
                type: string
            Payment-Receipt:
              description: Inline mpp payment receipt.
              schema:
                type: string
            X-PAYMENT-RESPONSE:
              description: Inline x402 payment receipt.
              schema:
                type: string
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            Input did not match the schema, or the upstream rejected the
            request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Missing or invalid API key.
        '402':
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/PaymentRequiredError'
                  - $ref: '#/components/schemas/TrialCapReached'
            application/problem+json:
              schema:
                properties:
                  challengeId:
                    minLength: 1
                    type: string
                  status:
                    const: 402
                    type: integer
                required:
                  - status
                  - challengeId
                type: object
          description: >-
            Insufficient wallet balance or spend cap, or an inline-payment
            challenge. Agent trials receive a trial_cap_reached continuation
            with a live RFC 8628 device authorization.
          headers:
            PAYMENT-REQUIRED:
              description: Inline x402 payment challenge.
              schema:
                type: string
            WWW-Authenticate:
              description: Inline mpp payment challenge.
              schema:
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            This API key's access (run only or read only) does not allow this
            operation.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            Unknown API. A target that does not exist is not a 404: the call
            succeeds with `output.found` false and `data` null.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            Idempotency collision. Codes: idempotency_in_progress means retry
            after the Retry-After delay; idempotency_conflict means use a new
            key for different request semantics; idempotency_needs_review means
            stop retrying and contact AnyAPI support with X-Anyapi-Request-Id.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            The request was well formed but this API cannot serve the requested
            target site; the body's `alternatives` array lists the AnyAPI APIs
            that can.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            The upstream was rate limited; resend the same request, with the
            same cursor if one was sent, after Retry-After seconds. Inspect
            `payment` when present before deciding whether to retry.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            An internal error prevented completion. Inspect payment when present
            before retrying.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            Every provider failed with a server/transport error, or inline
            payment settlement could not be confirmed; inspect `payment` when
            present before retrying.
      security:
        - bearerAuth: []
        - apiKeyAuth: []
        - {}
components:
  schemas:
    Error:
      properties:
        code:
          description: Stable machine-readable error code when the endpoint defines one.
          type: string
        error:
          description: Customer-safe error message.
          type: string
        payment:
          $ref: '#/components/schemas/Payment'
        requestId:
          description: >-
            This run's AnyAPI request id, the same value as the
            X-Anyapi-Request-Id response header. Quote it to support. Absent on
            endpoints that do not execute a run.
          format: uuid
          type: string
      required:
        - error
      type: object
    PaymentRequiredError:
      allOf:
        - $ref: '#/components/schemas/Error'
        - properties:
            error:
              not:
                const: trial_cap_reached
          type: object
    TrialCapReached:
      properties:
        error:
          const: trial_cap_reached
          type: string
        message:
          description: >-
            Human-relayable continuation instructions, including an executable
            token poll.
          type: string
        upgrade:
          $ref: '#/components/schemas/AgentUpgrade'
      required:
        - error
        - message
        - upgrade
      type: object
    Payment:
      properties:
        costUsd:
          description: Known USD payment amount for this request.
          minimum: 0
          type: number
        rail:
          minLength: 1
          type: string
        settlementState:
          enum:
            - charged_undelivered
            - indeterminate
          type: string
      required:
        - rail
        - settlementState
        - costUsd
      type: object
    AgentUpgrade:
      properties:
        authorizationServer:
          format: uri
          type: string
        clientId:
          type: string
        device:
          $ref: '#/components/schemas/DeviceUpgrade'
        scope:
          type: string
      required:
        - authorizationServer
        - scope
      type: object
    DeviceUpgrade:
      properties:
        deviceCode:
          type: string
        expiresIn:
          minimum: 0
          type: integer
        grantType:
          type: string
        interval:
          minimum: 1
          type: integer
        tokenEndpoint:
          format: uri
          type: string
        userCode:
          type: string
        verificationUri:
          format: uri
          type: string
        verificationUriComplete:
          format: uri
          type: string
      required:
        - verificationUriComplete
        - verificationUri
        - userCode
        - deviceCode
        - tokenEndpoint
        - grantType
        - interval
        - expiresIn
      type: object
  securitySchemes:
    bearerAuth:
      description: Your AnyAPI key as a Bearer token.
      scheme: bearer
      type: http
      x-default: YOUR_ANYAPI_KEY
    apiKeyAuth:
      description: Your AnyAPI key.
      in: header
      name: X-API-Key
      type: apiKey
      x-default: YOUR_ANYAPI_KEY

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.