ZoomInfo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Copilot API V1 Recommendations API

4 actions 4 updates phrasing extends openapi/zoominfo-recommendations-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/copilot/v1/companies/lookalikes'].get

$.paths['/copilot/v1/contacts/recommendations'].get

$.paths['/copilot/v1/contacts/lookalikes'].get

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 Copilot API V1 Recommendations API
  version: 1.0.0
extends: openapi/zoominfo-recommendations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/copilot/v1/companies/lookalikes'].get
  update:
    x-apievangelist-phrasing:
      intent: Find companies similar to a company
      effect: read
      questions:
      - Which companies look like my best customer?
      - Can I limit lookalike companies to the same country and industry?
      instructions:
      - text: Find companies similar to {companyId}.
        slots:
          companyId: query.filter[companyId]
      - text: Show lookalikes of {companyName} in the same industry {sameIndustry}.
        slots:
          companyName: query.filter[companyName]
          sameIndustry: query.filter[sameIndustry]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/contacts/recommendations'].get
  update:
    x-apievangelist-phrasing:
      intent: Recommend contacts at a target company
      effect: read
      questions:
      - Who should I reach out to at an account for prospecting?
      - Which stakeholders matter most for a renewal at a given company?
      instructions:
      - text: Recommend contacts at company {ziCompanyId} for {useCase}.
        slots:
          ziCompanyId: query.filter[ziCompanyId]
          useCase: query.filter[useCaseType]
      - text: Give me the top {size} people to contact at {ziCompanyId} for {useCase}.
        slots:
          size: query.page[size]
          ziCompanyId: query.filter[ziCompanyId]
          useCase: query.filter[useCaseType]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/contacts/lookalikes'].get
  update:
    x-apievangelist-phrasing:
      intent: Find people similar to a contact
      effect: read
      questions:
      - Who else looks like my champion at another account?
      - Can I find people similar to a given contact at a specific company?
      instructions:
      - text: Find people similar to contact {personId}.
        slots:
          personId: query.filter[referencePersonId]
      - text: Find lookalikes of {personId} at company {companyId}.
        slots:
          personId: query.filter[referencePersonId]
          companyId: query.filter[targetCompanyId]
      method: generated
      generated: '2026-09-26'