Snov.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snov.io Domain Search API

10 actions 10 updates phrasing extends openapi/snov-io-domain-search-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Snov.io's API. It is a proposal applied on top of the contract, not a document Snov.io publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/v2/domain-search/start'].post
$.paths['/v2/domain-search/result/{task_hash}'].get
$.paths['/v2/domain-search/prospects/start'].post
$.paths['/v2/domain-search/prospects/result/{task_hash}'].get
$.paths['/v2/domain-search/domain-emails/start'].post
$.paths['/v2/domain-search/domain-emails/result/{task_hash}'].get
$.paths['/v2/domain-search/generic-contacts/start'].post
$.paths['/v2/domain-search/generic-contacts/result/{task_hash}'].get
$.paths['/v1/get-domain-emails-count'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snov.io Domain Search API
  version: 1.0.0
extends: openapi/snov-io-domain-search-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: 9
- target: $.paths['/v2/domain-search/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a company domain search
      effect: read
      questions:
      - How do I look up what Snov.io knows about a company domain?
      - How many credits does a domain search cost?
      instructions:
      - text: Start a domain search for {domain}.
        slots:
          domain: requestBody.domain
      - text: Kick off a company lookup on domain {domain}.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/domain-search/result/{task_hash}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get company domain search results
      effect: read
      questions:
      - Where do I get the results of a domain search I already started?
      - Is my company domain lookup finished yet?
      instructions:
      - text: Get domain search results for task {task_hash}.
        slots:
          task_hash: path.task_hash
      - text: Fetch the company lookup result for task {task_hash}.
        slots:
          task_hash: path.task_hash
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/domain-search/prospects/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Find prospects at a company domain
      effect: read
      questions:
      - Can I find people who work at a company by its domain?
      - Is it possible to filter a company's prospects by job title?
      instructions:
      - text: Find prospects at {domain}.
        slots:
          domain: requestBody.domain
      - text: Search {domain} for prospects in positions {positions}, page {page}.
        slots:
          domain: requestBody.domain
          positions: requestBody.positions
          page: requestBody.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/domain-search/prospects/result/{task_hash}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get domain prospect search results
      effect: read
      questions:
      - Where do I collect the prospect profiles from a domain prospect search?
      - Has my search for people at a company finished?
      instructions:
      - text: Get prospect search results for task {task_hash}.
        slots:
          task_hash: path.task_hash
      - text: Fetch the people found by domain prospect task {task_hash}.
        slots:
          task_hash: path.task_hash
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/domain-search/domain-emails/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Find all email addresses at a domain
      effect: read
      questions:
      - Can I get every email address associated with a company domain?
      - What's the way to collect all known emails for a website?
      instructions:
      - text: Find all email addresses at {domain}.
        slots:
          domain: requestBody.domain
      - text: Start a domain emails search for {domain}.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/domain-search/domain-emails/result/{task_hash}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get domain email addresses search results
      effect: read
      questions:
      - Where are the email addresses from my domain emails search?
      - Is the list of emails for a domain ready to download?
      instructions:
      - text: Get domain emails results for task {task_hash}.
        slots:
          task_hash: path.task_hash
      - text: Fetch the email addresses found by task {task_hash}.
        slots:
          task_hash: path.task_hash
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/domain-search/generic-contacts/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Find generic contact addresses at a domain
      effect: read
      questions:
      - Can I find a company's info@ or support@ style addresses?
      - How do I look up generic role mailboxes for a domain?
      instructions:
      - text: Find generic contact addresses like info@ for {domain}.
        slots:
          domain: requestBody.domain
      - text: Start a generic contacts search on {domain}.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/domain-search/generic-contacts/result/{task_hash}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get generic contacts search results
      effect: read
      questions:
      - Where do I get the info@ and support@ addresses my search found?
      - Are the generic company mailboxes ready for my lookup?
      instructions:
      - text: Get generic contacts results for task {task_hash}.
        slots:
          task_hash: path.task_hash
      - text: Fetch the role mailboxes found by task {task_hash}.
        slots:
          task_hash: path.task_hash
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/get-domain-emails-count'].post
  update:
    x-apievangelist-phrasing:
      intent: Count available emails for a domain
      effect: read
      questions:
      - Can I check how many email addresses exist for a domain without spending credits?
      - How many emails are available for a company before I run a paid search?
      instructions:
      - text: Count available email addresses for {domain}.
        slots:
          domain: requestBody.domain
      - text: Check for free how many emails Snov.io has for {domain}.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'