# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ZoomInfo Bulk API
  version: 1.0.0
extends: openapi/zoominfo-bulk-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: 6
- target: $.paths['/bulk/search/contact'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk contact search job
      effect: write
      questions:
      - How do I pull a large list of contacts in one bulk job?
      - Can I preview a bulk contact search before redeeming credits?
      instructions:
      - text: Start a {jobType} bulk contact search for {query}.
        slots:
          jobType: requestBody.jobType
          query: requestBody.query
      - text: Run a bulk contact search job matching {query}.
        slots:
          query: requestBody.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk/search/company'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk company search job
      effect: write
      questions:
      - Can I export thousands of matching accounts through a bulk company search?
      - Which output fields can I request from a bulk company search?
      instructions:
      - text: Start a {jobType} bulk company search for {query} returning {outputFields}.
        slots:
          jobType: requestBody.jobType
          query: requestBody.query
          outputFields: requestBody.outputFields
      - text: Run a bulk company search job matching {query}.
        slots:
          query: requestBody.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk/enrich/contact'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk contact enrich job
      effect: write
      questions:
      - Can I enrich up to 10,000 contacts in a single job?
      - What's the way to enrich a big file of people at once?
      instructions:
      - text: Bulk enrich these contacts {people} and return {outputFields}.
        slots:
          people: requestBody.matchPersonInput
          outputFields: requestBody.outputFields
      - text: Start a bulk contact enrich job for {people}.
        slots:
          people: requestBody.matchPersonInput
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk/enrich/company'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk company enrich job
      effect: write
      questions:
      - Can I enrich up to 10,000 companies in a single job?
      - What's the way to enrich a big list of accounts at once?
      instructions:
      - text: Bulk enrich these companies {companies} and return {outputFields}.
        slots:
          companies: requestBody.matchCompanyInput
          outputFields: requestBody.outputFields
      - text: Start a bulk company enrich job for {companies}.
        slots:
          companies: requestBody.matchCompanyInput
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk/job/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk job's status
      effect: read
      questions:
      - Is my bulk search or enrich job queued, in progress, completed or failed?
      - How many matching records and pages does my bulk job have?
      instructions:
      - text: Check the status of bulk job {jobId}.
        slots:
          jobId: requestBody.jobId
      - text: Tell me how many records bulk job {jobId} matched.
        slots:
          jobId: requestBody.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk/job/results'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a page of bulk job results
      effect: read
      questions:
      - How do I download the results of a finished bulk job?
      - Can I fetch bulk job results one page at a time?
      instructions:
      - text: Get page {page} of results for bulk job {jobId}.
        slots:
          page: requestBody.page
          jobId: requestBody.jobId
      - text: Fetch the first page of results from bulk job {jobId}.
        slots:
          jobId: requestBody.jobId
      method: generated
      generated: '2026-09-26'