Explorium · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Service V2Businesses API

4 actions 4 updates phrasing extends openapi/explorium-v2businesses-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Explorium's API. It is a proposal applied on top of the contract, not a document Explorium publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v2/businesses/match'].post

$.paths['/v2/businesses'].post

$.paths['/v2/businesses/stats'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Partner Service V2Businesses API
  version: 1.0.0
extends: openapi/explorium-v2businesses-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v2/businesses/match'].post
  update:
    x-apievangelist-phrasing:
      intent: Match companies to business IDs (v2)
      effect: read
      questions:
      - How do I resolve company names and domains to business IDs in v2?
      - Can I match a whole list of companies to IDs in one request?
      instructions:
      - text: Match {businesses_to_match} to business IDs.
        slots:
          businesses_to_match: requestBody.businesses_to_match
      - text: Resolve the business ID of each company in {businesses_to_match}.
        slots:
          businesses_to_match: requestBody.businesses_to_match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/businesses'].post
  update:
    x-apievangelist-phrasing:
      intent: Search businesses by filters (v2)
      effect: read
      questions:
      - Which companies match my target country, size and industry?
      - Can I page through company search results with a cursor?
      instructions:
      - text: Find businesses matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Search companies with {filters}, {page_size} per page.
        slots:
          filters: requestBody.filters
          page_size: requestBody.page_size
      - text: Continue the business search from cursor {next_cursor}.
        slots:
          next_cursor: requestBody.next_cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/businesses/stats'].post
  update:
    x-apievangelist-phrasing:
      intent: Count businesses matching filters (v2)
      effect: read
      questions:
      - How many companies fall into my target segment?
      - Can I size a market of businesses before fetching them?
      instructions:
      - text: Count businesses matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Size the company segment defined by {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'