API Evangelist conversational phrasing for Context Brand Intelligence API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Context Brand Intelligence API
  version: 1.0.0
extends: openapi/contextdev-brand-intelligence-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/brand/retrieve'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's brand kit from its domain
      effect: read
      questions:
      - Can I get a company's logos, colors and industry just from its website domain?
      - What brand details come back when I look up a company's domain?
      - Can I set a maximum cache age when looking up brand data by domain in the query string?
      instructions:
      - text: Pull the full brand profile for the domain {domain}.
        slots:
          domain: query.domain
      - text: Get brand logos and colors for {domain} in {force_language}.
        slots:
          domain: query.domain
          force_language: query.force_language
      - text: Fetch brand data for {domain}, refreshing anything older than {maxAgeMs} ms.
        slots:
          domain: query.domain
          maxAgeMs: query.maxAgeMs
      method: generated
      generated: '2026-10-02'
- target: $.paths['/brand/retrieve'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up a brand with one identifier in a request body
      effect: read
      questions:
      - Which single endpoint lets me look up a brand by domain, name, email, ticker, transaction or direct URL in a JSON body?
      - Can I pull brand data only from one specific page URL rather than the whole internet?
      instructions:
      - text: Send a brand lookup request body with exactly one identifier and return the brand's logos, colors and industry.
      - text: Retrieve brand data using only the direct URL I give you in the request body, not a web-wide search.
      method: generated
      generated: '2026-10-02'
- target: $.paths['/brand/retrieve-by-name'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a brand by its company name
      effect: read
      questions:
      - I only know the company name, not its website. Can I still get its logo and colors?
      - Can I localize a company-name brand search to a specific country?
      instructions:
      - text: Look up the brand for the company named {name}.
        slots:
          name: query.name
      - text: Find brand data for company name {name}, searching in country {country_gl}.
        slots:
          name: query.name
          country_gl: query.country_gl
      method: generated
      generated: '2026-10-02'
- target: $.paths['/brand/retrieve-by-email'].get
  update:
    x-apievangelist-phrasing:
      intent: Identify a company's brand from a work email
      effect: read
      questions:
      - Can I figure out which company a signup belongs to from their work email address?
      - What happens if I look up a brand with a gmail or disposable email address?
      instructions:
      - text: Get the company brand behind the email address {email}.
        slots:
          email: query.email
      - text: Enrich new signup {email} with their employer's logo and colors.
        slots:
          email: query.email
      method: generated
      generated: '2026-10-02'
- target: $.paths['/brand/retrieve-by-ticker'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a public company's brand from its stock ticker
      effect: read
      questions:
      - Can I get a public company's logo from its stock ticker symbol like AAPL?
      - Does the ticker lookup let me specify which stock exchange the symbol trades on?
      instructions:
      - text: Pull brand data for the stock ticker {ticker}.
        slots:
          ticker: query.ticker
      - text: Get the brand for ticker {ticker} listed on exchange {ticker_exchange}.
        slots:
          ticker: query.ticker
          ticker_exchange: query.ticker_exchange
      method: generated
      generated: '2026-10-02'
- target: $.paths['/brand/retrieve-by-isin'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's brand from its ISIN
      effect: read
      questions:
      - Can I look up a company's brand assets from an ISIN securities identifier?
      - Which lookup should I use when my portfolio data only has ISIN codes?
      instructions:
      - text: Retrieve brand data for the ISIN {isin}.
        slots:
          isin: query.isin
      - text: Get the logo and colors of the issuer behind ISIN {isin}.
        slots:
          isin: query.isin
      method: generated
      generated: '2026-10-02'
- target: $.paths['/brand/transaction_identifier'].get
  update:
    x-apievangelist-phrasing:
      intent: Identify the merchant behind a card transaction
      effect: read
      questions:
      - How do I turn a messy bank transaction description into a recognizable merchant brand?
      - Can I pass the merchant category code or city to improve transaction matching?
      - Is there a high-confidence-only mode so wrong merchant matches are skipped?
      instructions:
      - text: Identify the merchant brand for the transaction text {transaction_info}.
        slots:
          transaction_info: query.transaction_info
      - text: Match transaction {transaction_info} with MCC {mcc} in {city} to a brand.
        slots:
          transaction_info: query.transaction_info
          mcc: query.mcc
          city: query.city
      - text: Find the brand for transaction {transaction_info}, only returning high-confidence matches {high_confidence_only}.
        slots:
          transaction_info: query.transaction_info
          high_confidence_only: query.high_confidence_only
      method: generated
      generated: '2026-10-02'
- target: $.paths['/brand/retrieve-simplified'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lightweight brand summary for a domain
      effect: read
      questions:
      - Is there a faster, smaller brand response with just the title, colors, logos and backdrops?
      - Can I pick a light or dark theme when fetching a domain's simplified brand assets?
      instructions:
      - text: Get just the essential logos and colors for {domain} using the simplified brand lookup.
        slots:
          domain: query.domain
      - text: Fetch simplified brand assets for {domain} with the {theme} theme.
        slots:
          domain: query.domain
          theme: query.theme
      method: generated
      generated: '2026-10-02'