> ## 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.

# Company Search - People Data Labs

> Search People Data Labs' company dataset with SQL or an Elasticsearch query and get the full firmographic record back, including funding history and the headcount growth, tenure and churn series. Billed per company returned.

**Price:** billed per result - \$120.00 per 1,000 results, capped at \$9,960.00 per 1,000 requests.

**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:** [Company Search - People Data Labs pricing and uptime](https://getanyapi.com/api/company-search/peopledatalabs) - live USD price, lane routing, and measured 30-day uptime. [Every Company_search endpoint](https://getanyapi.com/api/company-search).



## OpenAPI

````yaml /openapi.json post /v1/run/company_search.peopledatalabs
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: amazon
    x-group: Amazon
  - name: apollo
    x-group: Apollo
  - name: appstore
    x-group: Appstore
  - name: bluesky
    x-group: Bluesky
  - name: booking
    x-group: Booking
  - 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-search
    x-group: Company_search
  - name: congress
    x-group: Congress
  - name: dexscreener
    x-group: Dexscreener
  - name: douyin
    x-group: Douyin
  - 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: 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-shopping
    x-group: Google Shopping
  - name: hackernews
    x-group: Hackernews
  - name: indeed
    x-group: Indeed
  - name: instagram
    x-group: Instagram
  - name: job-search
    x-group: Job_search
  - name: linkedin
    x-group: Linkedin
  - name: maps
    x-group: Maps
  - name: mobile-phone
    x-group: Mobile_phone
  - name: naver
    x-group: Naver
  - name: pandaexpress
    x-group: Pandaexpress
  - 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: pinterest
    x-group: Pinterest
  - name: playstore
    x-group: Playstore
  - name: polymarket
    x-group: Polymarket
  - name: realtor
    x-group: Realtor
  - name: reddit
    x-group: Reddit
  - name: redfin
    x-group: Redfin
  - name: rednote
    x-group: Rednote
  - name: sec
    x-group: Sec
  - name: semrush
    x-group: Semrush
  - name: seo
    x-group: Seo
  - name: snapchat
    x-group: Snapchat
  - name: social
    x-group: Social
  - name: spotify
    x-group: Spotify
  - name: substack
    x-group: Substack
  - name: technographics
    x-group: Technographics
  - 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: upwork
    x-group: Upwork
  - 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/company_search.peopledatalabs:
    post:
      tags:
        - company-search
      summary: Company Search - People Data Labs
      description: >-
        Search People Data Labs' company dataset with SQL or an Elasticsearch
        query and get the full firmographic record back, including funding
        history and the headcount growth, tenure and churn series. Billed per
        company returned.


        **Price:** billed per result - \$120.00 per 1,000 results, capped at
        \$9,960.00 per 1,000 requests.


        **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:** [Company Search - People Data Labs pricing and
        uptime](https://getanyapi.com/api/company-search/peopledatalabs) - live
        USD price, lane routing, and measured 30-day uptime. [Every
        Company_search endpoint](https://getanyapi.com/api/company-search).
      operationId: company_search_peopledatalabs
      parameters:
        - description: >-
            Optional. Comma-separated keys (dotted paths like `author.name`
            descend into nested objects) to keep on each result item. Keys are
            matched relative to each result item after the `data`/`items`
            envelope is unwrapped, 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`. 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 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:
              limit: 1
              sql: SELECT * FROM company WHERE website = 'posthog.com'
            schema:
              additionalProperties: false
              anyOf:
                - required:
                    - sql
                - required:
                    - query
              example:
                limit: 1
                sql: SELECT * FROM company WHERE website = 'posthog.com'
              properties:
                dataInclude:
                  description: >-
                    Comma-separated People Data Labs fields to include, or a
                    leading - list to exclude. Projection changes the payload
                    only; billing still follows companies returned.
                  type: string
                limit:
                  default: 10
                  description: >-
                    Maximum companies to return. Every company returned is
                    billed, so start at 1 to check a query and read total before
                    asking for more.
                  maximum: 83
                  minimum: 1
                  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
                query:
                  additionalProperties: true
                  description: >-
                    Elasticsearch-style query over the People Data Labs company
                    dataset, e.g. {"bool": {"must": [{"term": {"website":
                    "posthog.com"}}]}}. Send this or sql, never both.
                  type: object
                sql:
                  description: >-
                    People Data Labs SQL, in the form SELECT * FROM company
                    WHERE ... . String literals take single quotes, only SELECT
                    * is supported, and field names must be real People Data
                    Labs company fields including nested subfields such as
                    location.country. Do not include a LIMIT clause; People Data
                    Labs rejects it. Use limit instead. Send this or query,
                    never both.
                  minLength: 1
                  type: string
                titlecase:
                  description: >-
                    Return text in title case instead of People Data Labs'
                    lowercase default.
                  type: boolean
              title: Company Search - People Data Labs 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 `requireCursor:
                      true` to be served only by a source that can page, which
                      may cost more per request.
                    type: string
                  items:
                    description: >-
                      Number of result rows returned. For per-result SKUs the
                      per-item cost is charged against this count; for
                      input-priced SKUs 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: >-
                              The matching companies plus the total the query
                              matched. People Data Labs paginates with a scroll
                              token that is not exposed here, so a call returns
                              one page and total tells you how much is behind
                              it.
                            oneOf:
                              - type: 'null'
                              - additionalProperties: false
                                properties:
                                  companies:
                                    description: Matching company records, up to limit.
                                    items:
                                      properties:
                                        affiliatedEntities:
                                          description: >-
                                            People Data Labs company ids of
                                            affiliated entities.
                                          items:
                                            type: string
                                          type: array
                                        affiliatedProfiles:
                                          description: >-
                                            People Data Labs company ids of
                                            affiliated profiles.
                                          items:
                                            type: string
                                          type: array
                                        allSubsidiaries:
                                          description: >-
                                            People Data Labs company ids of every
                                            subsidiary, at any depth.
                                          items:
                                            type: string
                                          type: array
                                        alternativeDomains:
                                          description: Other domains the company owns.
                                          items:
                                            type: string
                                          type: array
                                        alternativeNames:
                                          description: Other names the company trades under.
                                          items:
                                            type: string
                                          type: array
                                        averageEmployeeTenure:
                                          description: Average employee tenure in years.
                                          type: number
                                        averageTenureByLevel:
                                          additionalProperties: true
                                          description: >-
                                            Average tenure in years, keyed by
                                            seniority level.
                                          type: object
                                        averageTenureByRole:
                                          additionalProperties: true
                                          description: Average tenure in years, keyed by role.
                                          type: object
                                        directSubsidiaries:
                                          description: >-
                                            People Data Labs company ids of direct
                                            subsidiaries.
                                          items:
                                            type: string
                                          type: array
                                        employeeChurnRate:
                                          additionalProperties: true
                                          description: >-
                                            Churn rate keyed by window, e.g.
                                            12_month.
                                          type: object
                                        employeeCount:
                                          description: >-
                                            Employees People Data Labs currently
                                            counts.
                                          type: integer
                                        employeeCountByClass:
                                          additionalProperties: true
                                          description: Headcount keyed by job class.
                                          type: object
                                        employeeCountByCountry:
                                          additionalProperties: true
                                          description: Headcount keyed by country.
                                          type: object
                                        employeeCountByMonth:
                                          additionalProperties: true
                                          description: Headcount keyed by YYYY-MM month.
                                          type: object
                                        employeeCountByRole:
                                          additionalProperties: true
                                          description: Headcount keyed by role.
                                          type: object
                                        employeeCountBySubRole:
                                          additionalProperties: true
                                          description: Headcount keyed by sub-role.
                                          type: object
                                        employeeGrowthRate:
                                          additionalProperties: true
                                          description: Headcount growth rate keyed by window.
                                          type: object
                                        employeeGrowthRate12MonthByClass:
                                          additionalProperties: true
                                          description: >-
                                            Twelve-month headcount growth rate keyed
                                            by job class.
                                          type: object
                                        employeeGrowthRate12MonthByCountry:
                                          additionalProperties: true
                                          description: >-
                                            Twelve-month headcount growth keyed by
                                            country, each entry carrying current and
                                            prior headcount.
                                          type: object
                                        employeeGrowthRate12MonthByRole:
                                          additionalProperties: true
                                          description: >-
                                            Twelve-month headcount growth rate keyed
                                            by role.
                                          type: object
                                        employeeTurnoverRate:
                                          additionalProperties: true
                                          description: >-
                                            Turnover rate keyed by window, e.g.
                                            3_month, 12_month.
                                          type: object
                                        facebookUrl:
                                          description: Company Facebook page URL.
                                          format: uri
                                          type: string
                                        founded:
                                          description: Year the company was founded.
                                          type: integer
                                        fundingRounds:
                                          description: Number of funding rounds raised.
                                          type: integer
                                        fundingStages:
                                          description: >-
                                            Every funding stage the company has
                                            raised.
                                          items:
                                            type: string
                                          type: array
                                        grossAdditionsByMonth:
                                          additionalProperties: true
                                          description: >-
                                            Employees joined, keyed by YYYY-MM
                                            month.
                                          type: object
                                        grossDeparturesByMonth:
                                          additionalProperties: true
                                          description: >-
                                            Employees departed, keyed by YYYY-MM
                                            month.
                                          type: object
                                        headline:
                                          description: One-line company tagline.
                                          type: string
                                        immediateParent:
                                          description: >-
                                            People Data Labs company id of the
                                            immediate parent company.
                                          type: string
                                        industry:
                                          description: Company industry.
                                          type: string
                                        industryV2:
                                          description: >-
                                            Company industry on People Data Labs'
                                            newer taxonomy.
                                          type: string
                                        inferredRevenue:
                                          description: >-
                                            Inferred annual revenue band, e.g.
                                            $50M-$100M.
                                          type: string
                                        lastFundingUtc:
                                          description: >-
                                            UTC epoch timestamp in seconds (Unix
                                            time) of the most recent funding round.
                                            Multiply by 1000 for a JS Date in
                                            milliseconds.
                                          type: number
                                        latestFundingStage:
                                          description: >-
                                            Most recent funding stage, e.g.
                                            series_e.
                                          type: string
                                        linkedinFollowers:
                                          description: LinkedIn follower count.
                                          type: integer
                                        linkedinId:
                                          description: Company LinkedIn numeric id.
                                          type: string
                                        linkedinSlug:
                                          description: Company LinkedIn vanity slug.
                                          type: string
                                        linkedinUrl:
                                          description: Company LinkedIn page URL.
                                          format: uri
                                          type: string
                                        location:
                                          description: Company headquarters.
                                          properties:
                                            addressLine2:
                                              description: Second line of the address.
                                              type: string
                                            continent:
                                              description: Continent.
                                              type: string
                                            country:
                                              description: Country.
                                              type: string
                                            geo:
                                              description: Coordinates as "lat,lon".
                                              type: string
                                            locality:
                                              description: City.
                                              type: string
                                            metro:
                                              description: Metro area.
                                              type: string
                                            name:
                                              description: Location as one display string.
                                              type: string
                                            postalCode:
                                              description: Postal code.
                                              type: string
                                            region:
                                              description: State or region.
                                              type: string
                                            streetAddress:
                                              description: Street address.
                                              type: string
                                          type: object
                                        medianEmployeeTenure:
                                          description: Median employee tenure in years.
                                          type: number
                                        medianTenureByLevel:
                                          additionalProperties: true
                                          description: >-
                                            Median tenure in years, keyed by
                                            seniority level.
                                          type: object
                                        medianTenureByRole:
                                          additionalProperties: true
                                          description: Median tenure in years, keyed by role.
                                          type: object
                                        micExchange:
                                          description: >-
                                            MIC code of the exchange the company
                                            lists on.
                                          type: string
                                        naicsCodes:
                                          description: NAICS classification for the company.
                                          items:
                                            properties:
                                              code:
                                                description: NAICS code.
                                                type: string
                                              industryGroup:
                                                description: NAICS industry group.
                                                type: string
                                              naicsIndustry:
                                                description: NAICS industry.
                                                type: string
                                              nationalIndustry:
                                                description: NAICS national industry.
                                                type: string
                                              sector:
                                                description: NAICS sector.
                                                type: string
                                              subSector:
                                                description: NAICS sub-sector.
                                                type: string
                                            required:
                                              - code
                                            type: object
                                          type: array
                                        name:
                                          description: >-
                                            Company name as People Data Labs
                                            displays it.
                                          type: string
                                        nameNormalized:
                                          description: >-
                                            Lowercase normalized company name, the
                                            form People Data Labs matches on.
                                          type: string
                                        pdlId:
                                          description: People Data Labs persistent company id.
                                          type: string
                                        profiles:
                                          description: >-
                                            Every social profile People Data Labs
                                            links to the company.
                                          items:
                                            type: string
                                          type: array
                                        sicCodes:
                                          description: SIC classification for the company.
                                          items:
                                            properties:
                                              code:
                                                description: SIC code.
                                                type: string
                                              industryGroup:
                                                description: SIC industry group.
                                                type: string
                                              industrySector:
                                                description: SIC industry sector.
                                                type: string
                                              majorGroup:
                                                description: SIC major group.
                                                type: string
                                            required:
                                              - code
                                            type: object
                                          type: array
                                        size:
                                          description: Employee headcount band, e.g. 11-50.
                                          type: string
                                        summary:
                                          description: Long company description.
                                          type: string
                                        tags:
                                          description: Descriptive tags for the company.
                                          items:
                                            type: string
                                          type: array
                                        ticker:
                                          description: Stock ticker, for listed companies.
                                          type: string
                                        totalFundingRaised:
                                          description: Total capital raised, in USD.
                                          type: number
                                        twitterUrl:
                                          description: Company X (Twitter) profile URL.
                                          format: uri
                                          type: string
                                        type:
                                          description: Ownership type, e.g. private, public.
                                          type: string
                                        ultimateParent:
                                          description: >-
                                            People Data Labs company id of the
                                            ultimate parent company.
                                          type: string
                                        website:
                                          description: Company website domain.
                                          type: string
                                      required:
                                        - name
                                      type: object
                                    type: array
                                  datasetVersion:
                                    description: >-
                                      Version of the People Data Labs dataset
                                      these records came from.
                                    type: string
                                  total:
                                    description: >-
                                      Companies matching the query across the
                                      whole dataset, not just this page.
                                    type: integer
                                required:
                                  - companies
                                type: object
                          found:
                            description: False when the query matched no company.
                            type: boolean
                        required:
                          - found
                          - data
                        title: Company Search - People Data Labs 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
                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
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unknown SKU, or the upstream had no matching resource.
        '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; 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

````